@ahoo-wang/fetcher-wow 2.5.5 → 2.5.8

package/dist/index.es.js

@@ -493,6 +493,17 @@ class IE {
    * Creates a new QueryClientFactory instance with the specified default options.
    *
    * @param defaultOptions - The default options to be used for all query clients created by this factory
+   *
+   * @example
+   * ```typescript
+   * import { QueryClientFactory, ResourceAttributionPathSpec } from '@ahoo-wang/fetcher-wow';
+   *
+   * const factory = new QueryClientFactory({
+   *   contextAlias: 'example',
+   *   aggregateName: 'cart',
+   *   resourceAttribution: ResourceAttributionPathSpec.OWNER,
+   * });
+   * ```
    */
   constructor(E) {
     this.defaultOptions = E;
@@ -505,6 +516,15 @@ class IE {
    *
    * @param options - The query client options used to configure the snapshot query client
    * @returns A new instance of SnapshotQueryClient
+   *
+   * @example
+   * ```typescript
+   * const snapshotClient = factory.createSnapshotQueryClient({
+   *   aggregateName: 'cart',
+   * });
+   *
+   * const cartState = await snapshotClient.singleState({ condition: all() });
+   * ```
    */
   createSnapshotQueryClient(E) {
     const T = q({
@@ -521,6 +541,15 @@ class IE {
    *
    * @param options - The query client options used to configure the event stream query client
    * @returns A new instance of EventStreamQueryClient
+   *
+   * @example
+   * ```typescript
+   * const eventClient = factory.createEventStreamQueryClient({
+   *   aggregateName: 'cart',
+   * });
+   *
+   * const events = await eventClient.list({ condition: all() });
+   * ```
    */
   createEventStreamQueryClient(E) {
     const T = q({