@nymphjs/client 1.0.0-beta.76 → 1.0.0-beta.78

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.0.0-beta.78](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.77...v1.0.0-beta.78) (2024-09-27)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.77](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.76...v1.0.0-beta.77) (2024-09-26)
+
+**Note:** Version bump only for package @nymphjs/client
+
 # [1.0.0-beta.76](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.75...v1.0.0-beta.76) (2024-09-25)
 
 **Note:** Version bump only for package @nymphjs/client

package/lib/Nymph.types.d.ts

@@ -58,12 +58,37 @@ export type EventType = 'request' | 'response';
 export type RequestCallback = (url: string, options: RequestInit) => void;
 export type ResponseCallback = (response: Response, text: string) => void;
 export type Options<T extends EntityConstructor = EntityConstructor> = {
+    /**
+     * The Entity class to query.
+     */
     class: T;
+    /**
+     * The limit of entities to be returned. Not needed when using `getEntity`, as
+     * it always returns only one.
+     */
     limit?: number;
+    /**
+     * The offset from the first matching entity, in order, to start retrieving.
+     */
     offset?: number;
+    /**
+     * If true, entities will be retrieved from newest to oldest/largest to
+     * smallest (with regard to `sort`).
+     */
     reverse?: boolean;
+    /**
+     * How to sort the entities. Should be "cdate", "mdate", or the name of a
+     * property.
+     */
     sort?: 'cdate' | 'mdate' | string;
+    /**
+     * What to return, the entities with their data, just the GUIDs, or just a
+     * count.
+     */
     return?: 'entity' | 'guid' | 'count';
+    /**
+     * If true, Nymph will skip the cache and retrieve the entity from the DB.
+     */
     skipCache?: boolean;
 };
 export type Clause<C> = C | Exclude<C, undefined>[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nymphjs/client",
-  "version": "1.0.0-beta.76",
+  "version": "1.0.0-beta.78",
   "description": "Nymph.js - Client",
   "browser": "dist/index.js",
   "main": "lib/index.js",
@@ -50,5 +50,5 @@
     "fetch-event-source-hperrin": "^3.0.0",
     "lodash": "^4.17.21"
   },
-  "gitHead": "7a37be1f8a98a1529e591432683b6c6f1b65383e"
+  "gitHead": "064d1f6e384c6a4f57e33ca54b7d93c872ce9236"
 }

package/src/Nymph.types.ts

@@ -63,12 +63,37 @@ export type RequestCallback = (url: string, options: RequestInit) => void;
 export type ResponseCallback = (response: Response, text: string) => void;
 
 export type Options<T extends EntityConstructor = EntityConstructor> = {
+  /**
+   * The Entity class to query.
+   */
   class: T;
+  /**
+   * The limit of entities to be returned. Not needed when using `getEntity`, as
+   * it always returns only one.
+   */
   limit?: number;
+  /**
+   * The offset from the first matching entity, in order, to start retrieving.
+   */
   offset?: number;
+  /**
+   * If true, entities will be retrieved from newest to oldest/largest to
+   * smallest (with regard to `sort`).
+   */
   reverse?: boolean;
+  /**
+   * How to sort the entities. Should be "cdate", "mdate", or the name of a
+   * property.
+   */
   sort?: 'cdate' | 'mdate' | string;
+  /**
+   * What to return, the entities with their data, just the GUIDs, or just a
+   * count.
+   */
   return?: 'entity' | 'guid' | 'count';
+  /**
+   * If true, Nymph will skip the cache and retrieve the entity from the DB.
+   */
   skipCache?: boolean;
 };