@alwatr/signal 0.27.0 → 0.29.0

package/CHANGELOG.md

@@ -3,6 +3,50 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.29.0](https://github.com/AliMD/alwatr/compare/v0.28.0...v0.29.0) (2023-02-10)
+
+### Bug Fixes
+
+- **signal/core:** \_getSignalObject ([1374188](https://github.com/AliMD/alwatr/commit/1374188bdc7e689ded11d04bf4588a1162cc6d86))
+- **signal:** alert [#1455](https://github.com/AliMD/alwatr/issues/1455) ([203307d](https://github.com/AliMD/alwatr/commit/203307df308a12e6c38cb9e0e2301b2015b6ff45))
+- **signal:** clean old interfaces ([b2987ad](https://github.com/AliMD/alwatr/commit/b2987add7bfe0cf609fa355403fb9fb5de3f6b8a))
+- **signal:** export all interfaces ([8704eac](https://github.com/AliMD/alwatr/commit/8704eac6ae7a8a45e77c24ef5e602e36af3fd21e))
+- **signal:** export listeners ([fb05bfb](https://github.com/AliMD/alwatr/commit/fb05bfb9b7eb30427442783677ce1d4da5401160))
+- **signal:** import types ([cc0b88b](https://github.com/AliMD/alwatr/commit/cc0b88be420b1fe057a8640bbffb1af3bf327cef))
+- **signal:** interface bind type ([7b6c820](https://github.com/AliMD/alwatr/commit/7b6c820da2ba216f36e089bf79bdeccf208df3b1))
+- **signal:** reported issues ([75f688f](https://github.com/AliMD/alwatr/commit/75f688faf96a056a256603d05276f5731db86aee))
+- **signal:** TSignal on SignalControllerInterface ([ac42b7c](https://github.com/AliMD/alwatr/commit/ac42b7c7023549e8dd07cd3d9e189f356ffa06ee))
+
+### Features
+
+- **signal-manager:** enhance provider, docs ([c4583a3](https://github.com/AliMD/alwatr/commit/c4583a3b0fcbf38b5e426aaa2bc6e0f52ccac5fd))
+- **signal:** alias in SignalInterface & BoundSignalInterface ([053030b](https://github.com/AliMD/alwatr/commit/053030b96c09d474794f32327d892f1d3690656c))
+- **signal:** bind signal ([de49a13](https://github.com/AliMD/alwatr/commit/de49a13eaffce31660849dfc63285d97e9098c0c))
+- **signal:** command handler/provider interface ([3d23683](https://github.com/AliMD/alwatr/commit/3d236837e13d8cfdcd44a1570bdc9659f48e7f47))
+- **signal:** command signals ([98c1d90](https://github.com/AliMD/alwatr/commit/98c1d90978329e4c5c584e19edb1aaa365632162))
+- **signal:** command trigger interface ([dda9466](https://github.com/AliMD/alwatr/commit/dda94666d9e8e490fea26038044df0e67c203583))
+- **signal:** commandSignal ([5a0d7e5](https://github.com/AliMD/alwatr/commit/5a0d7e5498087620d28548ea5d90036a7b17483a))
+- **signal:** context prover and consumer ([081a51a](https://github.com/AliMD/alwatr/commit/081a51a1ee88e66ebbcd0c58186c00a6aa9e1032))
+- **signal:** contextProvider.expire ([7d0ce93](https://github.com/AliMD/alwatr/commit/7d0ce937f0eadcd9019e6047fbe07aa1a3b579a7))
+- **signal:** event listener interface ([4ca4079](https://github.com/AliMD/alwatr/commit/4ca407938d444027cdbd435173c875fdd9ce8e28))
+- **signal:** event trigger interface ([9b90597](https://github.com/AliMD/alwatr/commit/9b905979a5065640981433ec7d120ba2494966bb))
+- **signal:** new contextConsumer interface ([9ee4a62](https://github.com/AliMD/alwatr/commit/9ee4a624211adb66d9c3d180470cca44ed7df382))
+- **signal:** new contextProvider interface ([e5d29eb](https://github.com/AliMD/alwatr/commit/e5d29ebaa75d71bb5a87bedddb2be7600e68b210))
+- **signal:** new manager interface ([f028306](https://github.com/AliMD/alwatr/commit/f028306f4d7932df65a1bbeade0d29377a370e2e))
+- **signal:** new requestable context consumer interface ([bf6845f](https://github.com/AliMD/alwatr/commit/bf6845f35a98bb63bcfa42196c2f977d64aea59e))
+- **signal:** new requestable context provider interface ([2c8d576](https://github.com/AliMD/alwatr/commit/2c8d57604dcb07a2831d85d4ef1e262863a5fae8))
+- **signal:** new signal dynamic types ([0f1a38e](https://github.com/AliMD/alwatr/commit/0f1a38e356ab73e4e2e1a8f852585e50e86cff0e))
+- **signal:** new simple api ([eb1e478](https://github.com/AliMD/alwatr/commit/eb1e47892d4478fb6c687f6d15e1a5c204b5666c))
+- **signal:** refactor all generic types with Stringifyable ([bdcef63](https://github.com/AliMD/alwatr/commit/bdcef632c81fa5e7c7ae595a7a77092c53821850))
+- **signal:** separate request command with response ([47a779e](https://github.com/AliMD/alwatr/commit/47a779e9a814d5d6a388f1a3e94c23e7fb977dce))
+- **signal:** signal.request ([d791b3e](https://github.com/AliMD/alwatr/commit/d791b3eef846697020b76bfecfbf25a3e31eb3a5))
+- **signal:** signal.untilNext ([9df78c0](https://github.com/AliMD/alwatr/commit/9df78c03dea243b467504fdf422388ab9d2b5660))
+- **signal:** signals.expire ([3591efd](https://github.com/AliMD/alwatr/commit/3591efd5e42f7a981814fd59d7189b5066735302))
+
+# [0.28.0](https://github.com/AliMD/alwatr/compare/v0.27.0...v0.28.0) (2023-01-20)
+
+**Note:** Version bump only for package @alwatr/signal
+
 # [0.27.0](https://github.com/AliMD/alwatr/compare/v0.26.0...v0.27.0) (2022-12-29)
 
 **Note:** Version bump only for package @alwatr/signal

package/README.md

@@ -3,224 +3,3 @@
 Elegant powerful event system for handle global signals and states written in tiny TypeScript module.
 
 Every signal has own value and can be used as a advance **state management** like redux and recoil without the complexities and unnecessary facilities of those libraries.
-
-## Example usage
-
-### Add your signal name to global `AlwatrSignals` type helper
-
-```ts
-declare global {
-  /**
-   * Global signals value type registry.
-   */
-  interface AlwatrSignals {
-    readonly 'content-change': Record<string, number>;
-  }
-
-  /**
-   * Global request signal parameters types.
-   */
-  interface AlwatrRequestSignals {
-    readonly 'content-change': number;
-  }
-}
-```
-
-### Dispatch signal with value
-
-```ts
-import {SignalInterface} from 'https://esm.run/@alwatr/signal';
-
-const contentChangeSignal1 = new SignalInterface('content-change');
-
-contentChangeSignal1.dispatch({a: 1, b: 2});
-
-contentChangeSignal1.dispatch({a: 2, b: 3});
-
-// Multiple dispatch debounced and last value dispatched after an animation frame.
-contentChangeSignal1.dispatch({a: 3, b: 4});
-```
-
-### Receive the signal value
-
-```ts
-import {SignalInterface} from 'https://esm.run/@alwatr/signal';
-
-const contentChangeSignal2 = new SignalInterface('content-change'); // Same share signal as contentChangeSignal1
-
-contentChangeSignal2.addListener((content) => {
-  console.log(content); // {a:3, b:4}
-});
-```
-
-## API
-
-### Prepare
-
-#### `new SignalInterface(signal-name)`
-
-```ts
-import {SignalInterface} from 'https://esm.run/@alwatr/signal';
-
-const contentChangeSignal = new SignalInterface('content-change');
-```
-
-### `name`
-
-Get signal name.
-
-Example:
-
-```ts
-console.log(contentChangeSignal.name); // 'content-change'
-```
-
-### `value`
-
-Get last dispatched signal value or undefined.
-
-Example:
-
-```ts
-if (contentChangeSignal.dispatched) {
-  const content = contentChangeSignal.value!;
-  ...
-}
-```
-
-### `dispatched`
-
-Check signal dispatched before or not!
-
-Example
-
-```ts
-if (contentChangeSignal.dispatched) {
-  // contentChangeSignal.value exist.
-}
-```
-
-### `disabled`
-
-Disable signal, all dispatch's ignored (just value updated) and no more listeners will be called.
-
-Example:
-
-```ts
-contentChangeSignal.disabled = true;
-```
-
-### `expire()`
-
-Expire the signal by clear last dispatched value.
-
-dispatched and receivePrevious etc not work until new signal.
-
-Example:
-
-```ts
-contentChangeSignal.dispatched; // true
-contentChangeSignal.expire();
-contentChangeSignal.value; // undefined
-contentChangeSignal.dispatched; // false
-```
-
-### `setProvider(provider)`
-
-Defines the provider of the signal that will be called when the signal requested (addRequestSignalListener).
-
-Example:
-
-```ts
-contentChangeSignal.setProvider(async (requestParam) => {
-  const content = await fetchNewContent(requestParam);
-  if (content != null) {
-    return content; // Dispatch signal 'content-change' with content.
-  } else {
-    // dispatch new signal: 'content-not-found'
-  }
-});
-```
-
-### `request(requestParam)`
-
-Dispatch request signal and wait for answer (wait for new signal dispatched).
-
-Resolved with signal value when new signal received (getNextSignalValue).
-
-Example:
-
-```ts
-// dispatch request signal and wait for answer (wait for NEW signal).
-const newContent = await contentChangeSignal.request({foo: 'bar'});
-```
-
-### `getNextSignalValue()`
-
-Resolved with signal value when new signal received.
-
-Example:
-
-```ts
-// Wait for NEW signal received.
-const newContent = await contentChangeSignal.getNextSignalValue();
-```
-
-### `getSignalValue()`
-
-Resolved with signal value when signal is ready.
-
-Get signal value from last dispatched signal (if any) or wait for new signal received.
-
-Example:
-
-```ts
-// get signal value from last dispatched signal (if any) or wait for a new signal to receive
-const content = await contentChangeSignal.getSignalValue();
-```
-
-### `dispatch(signalValue)`
-
-Dispatch signal to all listeners.
-
-Example:
-
-```ts
-contentChangeSignal.dispatch(content);
-```
-
-### `addListener(listener)`
-
-Adds a new listener to the signal.
-
-Example:
-
-```ts
-const listener = contentChangeSignal.addListener((content) => console.log(content));
-```
-
-### Listener API Interface
-
-#### `listener.disabled`
-
-Disable the listener, not called anymore.
-
-Example:
-
-```ts
-const listener = contentChangeSignal.addListener((content) => console.log(content));
-...
-listener.disabled = true;
-```
-
-#### `listener.remove()`
-
-Removes a listener from the signal.
-
-Example:
-
-```ts
-const listener = contentChangeSignal.addListener((content) => console.log(content));
-...
-listener.remove();
-```

package/command-handler.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Command handler/define interface.
+ */
+export declare const commandHandler: {
+    /**
+     * Defines the command and dispatch returned value.
+     *
+     * Subscribe commandFunction to request-command-signal and dispatch callback-signal with commandFunction return value.
+     *
+     * Example:
+     *
+     * ```ts
+     * commandHandler.define<TArgument, TReturn>(
+     *   'show-prompt',
+     *   async (argumentObject) => {
+     *      return await showPrompt(argumentObject);
+     *   },
+     * );
+     * ```
+     */
+    readonly define: <TArgument extends import("@alwatr/type").StringifyableRecord, TReturn extends import("@alwatr/type").Stringifyable>(signalId: string, signalProvider: import("./type.js").ProviderFunction<TArgument & {
+        _callbackSignalId?: string | undefined;
+    }, TReturn>, options?: Partial<Pick<import("./type.js").ProviderOptions, "debounce">>) => void;
+};
+//# sourceMappingURL=command-handler.d.ts.map

package/command-handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"command-handler.d.ts","sourceRoot":"","sources":["src/command-handler.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,eAAO,MAAM,cAAc;IACzB;;;;;;;;;;;;;;;OAeG;;;;CAEK,CAAC"}

package/command-handler.js

@@ -0,0 +1,24 @@
+import { defineCommand } from './core.js';
+/**
+ * Command handler/define interface.
+ */
+export const commandHandler = {
+    /**
+     * Defines the command and dispatch returned value.
+     *
+     * Subscribe commandFunction to request-command-signal and dispatch callback-signal with commandFunction return value.
+     *
+     * Example:
+     *
+     * ```ts
+     * commandHandler.define<TArgument, TReturn>(
+     *   'show-prompt',
+     *   async (argumentObject) => {
+     *      return await showPrompt(argumentObject);
+     *   },
+     * );
+     * ```
+     */
+    define: defineCommand,
+};
+//# sourceMappingURL=command-handler.js.map

package/command-handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"command-handler.js","sourceRoot":"","sources":["src/command-handler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAC,MAAM,WAAW,CAAC;AAExC;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B;;;;;;;;;;;;;;;OAeG;IACH,MAAM,EAAE,aAAa;CACb,CAAC","sourcesContent":["import {defineCommand} from './core.js';\n\n/**\n * Command handler/define interface.\n */\nexport const commandHandler = {\n  /**\n   * Defines the command and dispatch returned value.\n   *\n   * Subscribe commandFunction to request-command-signal and dispatch callback-signal with commandFunction return value.\n   *\n   * Example:\n   *\n   * ```ts\n   * commandHandler.define<TArgument, TReturn>(\n   *   'show-prompt',\n   *   async (argumentObject) => {\n   *      return await showPrompt(argumentObject);\n   *   },\n   * );\n   * ```\n   */\n  define: defineCommand,\n} as const;\n"]}

package/command-trigger.d.ts

@@ -0,0 +1,64 @@
+import type { Stringifyable, StringifyableRecord } from '@alwatr/type';
+/**
+ * Command trigger/request interface.
+ */
+export declare const commandTrigger: {
+    /**
+     * Dispatch request command signal with commandArgument as detail.
+     *
+     * Example:
+     *
+     * ```ts
+     * commandTrigger.request<ArgumentType>('show-dialog', {foo: 'bar'});
+     * ```
+     */
+    readonly request: <TArgument extends StringifyableRecord>(commandId: string, commandArgument: TArgument) => void;
+    /**
+     * Dispatch request command signal with commandArgument as detail and return untilNext of callback signal.
+     *
+     * Request command and wait for answer.
+     *
+     * Example:
+     *
+     * ```ts
+     * const response = await commandTrigger.requestWithResponse<ArgumentType, ReturnType>('show-dialog', {foo: 'bar'});
+     * ```
+     */
+    readonly requestWithResponse: <TArgument_1 extends StringifyableRecord, TReturn extends Stringifyable>(commandId: string, commandArgument: TArgument_1) => Promise<TReturn>;
+    /**
+     * Bind define command to special command.
+     *
+     * Example:
+     *
+     * ```ts
+     * const showDialog = commandTrigger.bind<ArgumentType, ReturnType>('show-dialog');
+     * ```
+     */
+    readonly bind: <TArgument_2 extends StringifyableRecord, TReturn_1 extends Stringifyable>(commandId: string) => {
+        /**
+         * Command signal Id.
+         */
+        id: string;
+        /**
+         * Dispatch request command signal with commandArgument as detail and return untilNext of callback signal.
+         *
+         * Example:
+         *
+         * ```ts
+         * showDialog.request({foo: 'bar'});
+         * ```
+         */
+        request: (commandArgument: TArgument_2) => void;
+        /**
+         * Dispatch request command signal with commandArgument as detail and return untilNext of callback signal.
+         *
+         * Example:
+         *
+         * ```ts
+         * const response = await showDialog.requestWithResponse({foo: 'bar'});
+         * ```
+         */
+        requestWithResponse: (commandArgument: TArgument_2) => Promise<TReturn_1>;
+    };
+};
+//# sourceMappingURL=command-trigger.d.ts.map

package/command-trigger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"command-trigger.d.ts","sourceRoot":"","sources":["src/command-trigger.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAiB,aAAa,EAAE,mBAAmB,EAAC,MAAM,cAAc,CAAC;AAErF;;GAEG;AACH,eAAO,MAAM,cAAc;IACzB;;;;;;;;OAQG;;IAGH;;;;;;;;;;OAUG;;IAGH;;;;;;;;OAQG;yGACqF,MAAM;QAC5F;;WAEG;;QAGH;;;;;;;;WAQG;;QAIH;;;;;;;;WAQG;;;CAIG,CAAC"}

package/command-trigger.js

@@ -0,0 +1,64 @@
+import { requestCommand, requestCommandWithResponse } from './core.js';
+/**
+ * Command trigger/request interface.
+ */
+export const commandTrigger = {
+    /**
+     * Dispatch request command signal with commandArgument as detail.
+     *
+     * Example:
+     *
+     * ```ts
+     * commandTrigger.request<ArgumentType>('show-dialog', {foo: 'bar'});
+     * ```
+     */
+    request: requestCommand,
+    /**
+     * Dispatch request command signal with commandArgument as detail and return untilNext of callback signal.
+     *
+     * Request command and wait for answer.
+     *
+     * Example:
+     *
+     * ```ts
+     * const response = await commandTrigger.requestWithResponse<ArgumentType, ReturnType>('show-dialog', {foo: 'bar'});
+     * ```
+     */
+    requestWithResponse: requestCommandWithResponse,
+    /**
+     * Bind define command to special command.
+     *
+     * Example:
+     *
+     * ```ts
+     * const showDialog = commandTrigger.bind<ArgumentType, ReturnType>('show-dialog');
+     * ```
+     */
+    bind: (commandId) => ({
+        /**
+         * Command signal Id.
+         */
+        id: commandId,
+        /**
+         * Dispatch request command signal with commandArgument as detail and return untilNext of callback signal.
+         *
+         * Example:
+         *
+         * ```ts
+         * showDialog.request({foo: 'bar'});
+         * ```
+         */
+        request: requestCommand.bind(null, commandId),
+        /**
+         * Dispatch request command signal with commandArgument as detail and return untilNext of callback signal.
+         *
+         * Example:
+         *
+         * ```ts
+         * const response = await showDialog.requestWithResponse({foo: 'bar'});
+         * ```
+         */
+        requestWithResponse: requestCommandWithResponse.bind(null, commandId),
+    }),
+};
+//# sourceMappingURL=command-trigger.js.map

package/command-trigger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"command-trigger.js","sourceRoot":"","sources":["src/command-trigger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,cAAc,EAAE,0BAA0B,EAAC,MAAM,WAAW,CAAC;AAIrE;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B;;;;;;;;OAQG;IACH,OAAO,EAAE,cAAc;IAEvB;;;;;;;;;;OAUG;IACH,mBAAmB,EAAE,0BAA0B;IAE/C;;;;;;;;OAQG;IACH,IAAI,EAAE,CAAuE,SAAiB,EAAE,EAAE,CAAA,CAAC;QACjG;;WAEG;QACH,EAAE,EAAE,SAAS;QAEb;;;;;;;;WAQG;QACH,OAAO,EAAE,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CACM;QAElD;;;;;;;;WAQG;QACH,mBAAmB,EAAE,0BAA0B,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CACG;KACxE,CAAC;CACM,CAAC","sourcesContent":["import {requestCommand, requestCommandWithResponse} from './core.js';\n\nimport type {OmitFirstParam, Stringifyable, StringifyableRecord} from '@alwatr/type';\n\n/**\n * Command trigger/request interface.\n */\nexport const commandTrigger = {\n  /**\n   * Dispatch request command signal with commandArgument as detail.\n   *\n   * Example:\n   *\n   * ```ts\n   * commandTrigger.request<ArgumentType>('show-dialog', {foo: 'bar'});\n   * ```\n   */\n  request: requestCommand,\n\n  /**\n   * Dispatch request command signal with commandArgument as detail and return untilNext of callback signal.\n   *\n   * Request command and wait for answer.\n   *\n   * Example:\n   *\n   * ```ts\n   * const response = await commandTrigger.requestWithResponse<ArgumentType, ReturnType>('show-dialog', {foo: 'bar'});\n   * ```\n   */\n  requestWithResponse: requestCommandWithResponse,\n\n  /**\n   * Bind define command to special command.\n   *\n   * Example:\n   *\n   * ```ts\n   * const showDialog = commandTrigger.bind<ArgumentType, ReturnType>('show-dialog');\n   * ```\n   */\n  bind: <TArgument extends StringifyableRecord, TReturn extends Stringifyable>(commandId: string) =>({\n    /**\n     * Command signal Id.\n     */\n    id: commandId,\n\n    /**\n     * Dispatch request command signal with commandArgument as detail and return untilNext of callback signal.\n     *\n     * Example:\n     *\n     * ```ts\n     * showDialog.request({foo: 'bar'});\n     * ```\n     */\n    request: requestCommand.bind(null, commandId) as unknown as\n      OmitFirstParam<typeof requestCommand<TArgument>>,\n\n    /**\n     * Dispatch request command signal with commandArgument as detail and return untilNext of callback signal.\n     *\n     * Example:\n     *\n     * ```ts\n     * const response = await showDialog.requestWithResponse({foo: 'bar'});\n     * ```\n     */\n    requestWithResponse: requestCommandWithResponse.bind(null, commandId) as unknown as\n      OmitFirstParam<typeof requestCommandWithResponse<TArgument, TReturn>>,\n  }),\n} as const;\n"]}

package/context-consumer.d.ts

@@ -0,0 +1,124 @@
+import type { Stringifyable } from '@alwatr/type';
+/**
+ * Context consumer interface.
+ */
+export declare const contextConsumer: {
+    /**
+     * Get context value.
+     *
+     * Return undefined if context not set before or expired.
+     *
+     * Example:
+     *
+     * ```ts
+     * const currentProductList = contextConsumer.getValue<ProductListType>('product-list');
+     * if (currentProductList === undefined) {
+     *   // productList not set before or expired.
+     * }
+     * ```
+     */
+    readonly getValue: <T extends Stringifyable>(signalId: string) => T | undefined;
+    /**
+     * Waits until the context value changes.
+     *
+     * Example:
+     *
+     * ```ts
+     * const newProductList = await contextConsumer.untilChange<ProductListType>('product-list');
+     * ```
+     */
+    readonly untilChange: <T_1 extends Stringifyable>(signalId: string) => Promise<T_1>;
+    /**
+     * Subscribe to context changes, work like addEventListener.
+     *
+     * Example:
+     *
+     * ```ts
+     * const listener = contextConsumer.subscribe<ProductListType>('product-list', (productList) => {
+     *   console.log(productList);
+     * });
+     * // ...
+     * contextConsumer.unsubscribe(listener);
+     * ```
+     */
+    readonly subscribe: <T_2 extends Stringifyable>(signalId: string, listenerCallback: import("./type.js").ListenerFunction<T_2>, options?: Partial<import("./type.js").SubscribeOptions>) => import("./type.js").ListenerSpec;
+    /**
+     * Unsubscribe from context changes, work like removeEventListener.
+     *
+     * Example:
+     *
+     * ```ts
+     * const listener = contextConsumer.subscribe<ProductListType>('product-list', (productList) => {
+     *   console.log(productList);
+     * });
+     * // ...
+     * contextConsumer.unsubscribe(listener);
+     * ```
+     */
+    readonly unsubscribe: (listener: import("./type.js").ListenerSpec) => void;
+    /**
+     * Bind this interface to special context.
+     *
+     * Example:
+     *
+     * ```ts
+     * const productListConsumer = contextConsumer.bind<ProductListType>('product-list');
+     * ```
+     */
+    readonly bind: <T_3 extends Stringifyable>(contextId: string) => {
+        /**
+         * Context signal Id.
+         */
+        readonly id: string;
+        /**
+         * Get context value.
+         *
+         * Return undefined if context not set before or expired.
+         *
+         * Example:
+         *
+         * ```ts
+         * const currentProductList = productListConsumer.getValue();
+         * if (currentProductList === undefined) {
+         *   // productList not set before or expired.
+         * }
+         * ```
+         */
+        readonly getValue: () => T_3 | undefined;
+        /**
+         * Waits until the context value changes.
+         *
+         * Example:
+         *
+         * ```ts
+         * const newProductList = await productListConsumer.untilChange();
+         * ```
+         */
+        readonly untilChange: () => Promise<T_3>;
+        /**
+         * Subscribe to context changes, work like addEventListener.
+         *
+         * Example:
+         *
+         * ```ts
+         * const listener = productListConsumer.subscribe((productList) => console.log(productList));
+         * // ...
+         * productListConsumer.unsubscribe(listener);
+         * ```
+         */
+        readonly subscribe: (listenerCallback: import("./type.js").ListenerFunction<T_3>, options?: Partial<import("./type.js").SubscribeOptions> | undefined) => import("./type.js").ListenerSpec;
+        /**
+         * Unsubscribe from context changes, work like removeEventListener.
+         *
+         * Example:
+         *
+         * ```ts
+         * const listener = productListConsumer.subscribe((productList) => console.log(productList));
+         * // ...
+         * productListConsumer.unsubscribe(listener);
+         * ```
+         */
+        readonly unsubscribe: (listener: import("./type.js").ListenerSpec) => void;
+    };
+};
+//# sourceMappingURL=context-consumer.d.ts.map

package/context-consumer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context-consumer.d.ts","sourceRoot":"","sources":["src/context-consumer.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAC,aAAa,EAAiB,MAAM,cAAc,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,eAAe;IAC1B;;;;;;;;;;;;;OAaG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;;;;;;OAYG;;IAGH;;;;;;;;;;;;OAYG;;IAGH;;;;;;;;OAQG;0DACwC,MAAM;QAC/C;;WAEG;;QAGH;;;;;;;;;;;;;WAaG;;QAGH;;;;;;;;WAQG;;QAGH;;;;;;;;;;WAUG;;QAIH;;;;;;;;;;WAUG;;;CAGG,CAAC"}