docs: improve jsdoc for SortHelperArgsOpts.multi

* Update README.md

Add example to SortHelperArgsOpts description and make note that only indexed field will ever be added to sort enum

* docs: improve jsdoc for SortHelperArgsOpts

Co-authored-by: nodkz <[email protected]>

Author: sgpinkus

README.md

@@ -730,8 +730,8 @@ type FilterHelperArgsOpts = {
 ```ts
 type SortHelperArgsOpts = {
   /**
-   * Allow sort by several fields.
-   * This makes arg as array of sort values.
+   * Allow sort arg to be an array of enum values. Example [AGE_DESC, NAME_ASC, _ID_ASC].
+   * Note enum values will only ever be generated for *indexed fields*.
    */
   multi?: boolean;
   /**

src/resolvers/helpers/sort.ts

@@ -13,8 +13,8 @@ import type { ExtendedResolveParams } from '../index';
 
 export type SortHelperArgsOpts = {
   /**
-   * Allow sort by several fields.
-   * This makes arg as array of sort values.
+   * Allow sort arg to be an array of enum values. Example [AGE_DESC, NAME_ASC, _ID_ASC].
+   * Note enum values will only ever be generated for *indexed fields*.
    */
   multi?: boolean;
   /**