refactor: update docblocks

Author: thetutlage

src/base_transformer.ts

@@ -11,8 +11,8 @@ import { RuntimeException } from '@poppinss/exception'
 
 import { Maybe } from './maybe.ts'
 import { Item } from './resource/item.ts'
-import { Collection } from './resource/collection.ts'
 import { Paginator } from './paginator.ts'
+import { Collection } from './resource/collection.ts'
 
 /**
  * Serves as the base for creating custom data transformers.

src/paginator.ts

@@ -64,12 +64,40 @@ export class Paginator<
     protected metaData: MetaData
   ) {}
 
+  /**
+   * Sets a new data property name for the paginated result
+   *
+   * @param dataProp - The new property name for the data array
+   *
+   * @example
+   * ```ts
+   * const paginator = new Paginator(collection, 'data', { page: 1 })
+   * const newPaginator = paginator.setDataProp('users')
+   * // Result will have 'users' instead of 'data' as the key
+   * ```
+   */
   setDataProp<Value extends string>(
     dataProp: Value
   ): Paginator<PaginatorCollection, Value, MetaData> {
     return new Paginator(this.collection, dataProp, this.metaData)
   }
 
+  /**
+   * Updates the pagination metadata with new values
+   *
+   * @param metaData - New metadata object or a function that receives current metadata and returns new metadata
+   *
+   * @example
+   * ```ts
+   * const paginator = new Paginator(collection, 'data', { page: 1, total: 100 })
+   *
+   * // Set new metadata
+   * const updated = paginator.setMetaData({ page: 2, total: 150, hasMore: true })
+   *
+   * // Update existing metadata
+   * const incremented = paginator.setMetaData(meta => ({ ...meta, page: meta.page + 1 }))
+   * ```
+   */
   setMetaData<Value extends Record<string, any>>(
     metaData: Value | ((data: MetaData) => Value)
   ): Paginator<PaginatorCollection, DataProp, Value> {

src/serialize.ts

@@ -7,14 +7,14 @@
  * file that was distributed with this source code.
  */
 
+import { RuntimeException } from '@poppinss/exception'
 import { Container, type ContainerResolver } from '@adonisjs/fold'
 
 import { Item } from './resource/item.ts'
 import { Paginator } from './paginator.ts'
 import { serializeValues } from './utils.ts'
 import { Collection } from './resource/collection.ts'
 import type { ResourceDataTypes, SerializeFn } from './types.ts'
-import { RuntimeException } from '@poppinss/exception'
 
 /**
  * Main serialization function that converts transformer data into plain JavaScript objects.

src/utils.ts

@@ -12,9 +12,9 @@ import type { ContainerResolver } from '@adonisjs/fold'
 
 import { debug } from './debug.ts'
 import { Item } from './resource/item.ts'
+import { Paginator } from './paginator.ts'
 import { Collection } from './resource/collection.ts'
 import type { JSONDataTypes, ResourceData } from './types.ts'
-import { Paginator } from './paginator.ts'
 
 /**
  * Checks if value is an object excluding Arrays and null values