@difizen/libro-common 0.0.2-alpha.0 → 0.1.0

package/es/iter.d.ts

@@ -1,147 +0,0 @@
-/**
- * An object which can produce an iterator over its values.
- */
-export interface IIterable<T> {
-    /**
-     * Get an iterator over the object's values.
-     *
-     * @returns An iterator which yields the object's values.
-     *
-     * #### Notes
-     * Depending on the iterable, the returned iterator may or may not be
-     * a new object. A collection or other container-like object should
-     * typically return a new iterator, while an iterator itself should
-     * normally return `this`.
-     */
-    iter: () => IIterator<T>;
-}
-/**
- * An object which traverses a collection of values.
- *
- * #### Notes
- * An `IIterator` is itself an `IIterable`. Most implementations of
- * `IIterator` should simply return `this` from the `iter()` method.
- */
-export interface IIterator<T> extends IIterable<T> {
-    /**
-     * Create an independent clone of the iterator.
-     *
-     * @returns A new independent clone of the iterator.
-     *
-     * #### Notes
-     * The cloned iterator can be consumed independently of the current
-     * iterator. In essence, it is a copy of the iterator value stream
-     * which starts at the current location.
-     *
-     * This can be useful for lookahead and stream duplication.
-     */
-    clone: () => IIterator<T>;
-    /**
-     * Get the next value from the iterator.
-     *
-     * @returns The next value from the iterator, or `undefined`.
-     *
-     * #### Notes
-     * The `undefined` value is used to signal the end of iteration and
-     * should therefore not be used as a value in a collection.
-     *
-     * The use of the `undefined` sentinel is an explicit design choice
-     * which favors performance over purity. The ES6 iterator design of
-     * returning a `{ value, done }` pair is suboptimal, as it requires
-     * an object allocation on each iteration; and an `isDone()` method
-     * would increase implementation and runtime complexity.
-     */
-    next: () => T | undefined;
-}
-/**
- * A type alias for an iterable or builtin array-like object.
- */
-export type IterableOrArrayLike<T> = IIterable<T> | ArrayLike<T>;
-/**
- * An iterator for an array-like object.
- *
- * #### Notes
- * This iterator can be used for any builtin JS array-like object.
- */
-export declare class ArrayIterator<T> implements IIterator<T> {
-    /**
-     * Construct a new array iterator.
-     *
-     * @param source - The array-like object of interest.
-     */
-    constructor(source: ArrayLike<T>);
-    /**
-     * Get an iterator over the object's values.
-     *
-     * @returns An iterator which yields the object's values.
-     */
-    iter(): IIterator<T>;
-    /**
-     * Create an independent clone of the iterator.
-     *
-     * @returns A new independent clone of the iterator.
-     */
-    clone(): IIterator<T>;
-    /**
-     * Get the next value from the iterator.
-     *
-     * @returns The next value from the iterator, or `undefined`.
-     */
-    next(): T | undefined;
-    private _index;
-    private _source;
-}
-/**
- * Create an iterator for an iterable object.
- *
- * @param object - The iterable or array-like object of interest.
- *
- * @returns A new iterator for the given object.
- *
- * #### Notes
- * This function allows iteration algorithms to operate on user-defined
- * iterable types and builtin array-like objects in a uniform fashion.
- */
-export declare function iter<T>(object: IterableOrArrayLike<T>): IIterator<T>;
-/**
- * Invoke a function for each value in an iterable.
- *
- * @param object - The iterable or array-like object of interest.
- *
- * @param fn - The callback function to invoke for each value.
- *
- * #### Notes
- * Iteration can be terminated early by returning `false` from the
- * callback function.
- *
- * #### Complexity
- * Linear.
- *
- * #### Example
- * ```typescript
- *
- * let data = [5, 7, 0, -2, 9];
- *
- * each(data, value => { console.log(value); });
- * ```
- */
-export declare function each<T>(object: IterableOrArrayLike<T>, fn: (value: T, index: number) => boolean | void): void;
-/**
- * Create an array from an iterable of values.
- *
- * @param object - The iterable or array-like object of interest.
- *
- * @returns A new array of values from the given object.
- *
- * #### Example
- * ```typescript
- *
- * let data = [1, 2, 3, 4, 5, 6];
- *
- * let stream = iter(data);
- *
- * toArray(stream);  // [1, 2, 3, 4, 5, 6];
- * ```
- */
-export declare function toArray<T>(object: IterableOrArrayLike<T>): T[];
-//# sourceMappingURL=iter.d.ts.map

package/es/iter.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"iter.d.ts","sourceRoot":"","sources":["../src/iter.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC;IAC1B;;;;;;;;;;OAUG;IACH,IAAI,EAAE,MAAM,SAAS,CAAC,CAAC,CAAC,CAAC;CAC1B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC,CAAE,SAAQ,SAAS,CAAC,CAAC,CAAC;IAChD;;;;;;;;;;;OAWG;IACH,KAAK,EAAE,MAAM,SAAS,CAAC,CAAC,CAAC,CAAC;IAE1B;;;;;;;;;;;;;;OAcG;IACH,IAAI,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;AAEjE;;;;;GAKG;AACH,qBAAa,aAAa,CAAC,CAAC,CAAE,YAAW,SAAS,CAAC,CAAC,CAAC;IACnD;;;;OAIG;gBACS,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;IAIhC;;;;OAIG;IACH,IAAI,IAAI,SAAS,CAAC,CAAC,CAAC;IAIpB;;;;OAIG;IACH,KAAK,IAAI,SAAS,CAAC,CAAC,CAAC;IAMrB;;;;OAIG;IACH,IAAI,IAAI,CAAC,GAAG,SAAS;IAOrB,OAAO,CAAC,MAAM,CAAK;IACnB,OAAO,CAAC,OAAO,CAAe;CAC/B;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAQpE;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,IAAI,CAAC,CAAC,EACpB,MAAM,EAAE,mBAAmB,CAAC,CAAC,CAAC,EAC9B,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,GAAG,IAAI,GAC9C,IAAI,CASN;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAS9D"}

package/es/json.d.ts

@@ -1,126 +0,0 @@
-/**
- * A type alias for a JSON primitive.
- */
-export type JSONPrimitive = boolean | number | string | null;
-/**
- * A type alias for a JSON value.
- */
-export type JSONValue = JSONPrimitive | {
-    [key: string]: JSONValue;
-} | JSONValue[];
-/**
- * A type definition for a JSON object.
- */
-export type JSONObject = Record<string, JSONValue>;
-/**
- * A type definition for a JSON array.
- */
-export type JSONArray = JSONValue[];
-/**
- * A type definition for a readonly JSON object.
- */
-export type ReadonlyJSONObject = Readonly<Record<string, ReadonlyJSONValue>>;
-/**
- * A type definition for a readonly JSON array.
- */
-export type ReadonlyJSONArray = readonly ReadonlyJSONValue[];
-/**
- * A type alias for a readonly JSON value.
- */
-export type ReadonlyJSONValue = JSONPrimitive | Readonly<{
-    [key: string]: ReadonlyJSONValue;
-}> | readonly ReadonlyJSONValue[];
-/**
- * A type alias for a partial JSON value.
- *
- * Note: Partial here means that JSON object attributes can be `undefined`.
- */
-export type PartialJSONValue = JSONPrimitive | Partial<{
-    [key: string]: PartialJSONValue;
-}> | PartialJSONValue[];
-/**
- * A type definition for a partial JSON array.
- *
- * Note: Partial here means that JSON object attributes can be `undefined`.
- */
-export type PartialJSONArray = PartialJSONValue[];
-/**
- * A type definition for a partial JSON object.
- *
- * Note: Partial here means that the JSON object attributes can be `undefined`.
- */
-export type PartialJSONObject = Record<string, PartialJSONValue | undefined>;
-/**
- * A type definition for a readonly partial JSON object.
- *
- * Note: Partial here means that JSON object attributes can be `undefined`.
- */
-export type ReadonlyPartialJSONObject = Readonly<Record<string, ReadonlyPartialJSONValue | undefined>>;
-/**
- * A type definition for a readonly partial JSON array.
- *
- * Note: Partial here means that JSON object attributes can be `undefined`.
- */
-export type ReadonlyPartialJSONArray = readonly ReadonlyPartialJSONValue[];
-/**
- * A type alias for a readonly partial JSON value.
- *
- * Note: Partial here means that JSON object attributes can be `undefined`.
- */
-export type ReadonlyPartialJSONValue = JSONPrimitive | {
-    readonly [key: string]: ReadonlyPartialJSONValue | undefined;
-} | readonly ReadonlyPartialJSONValue[];
-/**
- * A shared frozen empty JSONObject
- */
-export declare const emptyObject: Readonly<Record<string, ReadonlyJSONValue>>;
-/**
- * A shared frozen empty JSONArray
- */
-export declare const emptyArray: ReadonlyJSONArray;
-/**
- * Test whether a JSON value is a primitive.
- *
- * @param value - The JSON value of interest.
- *
- * @returns `true` if the value is a primitive,`false` otherwise.
- */
-export declare function isPrimitive(value: ReadonlyPartialJSONValue): value is JSONPrimitive;
-/**
- * Test whether a JSON value is an array.
- *
- * @param value - The JSON value of interest.
- *
- * @returns `true` if the value is a an array, `false` otherwise.
- */
-export declare function isArray(value: JSONValue): value is JSONArray;
-export declare function isArray(value: PartialJSONValue): value is PartialJSONArray;
-export declare function isArray(value: ReadonlyPartialJSONValue): value is ReadonlyPartialJSONArray;
-/**
- * Test whether a JSON value is an object.
- *
- * @param value - The JSON value of interest.
- *
- * @returns `true` if the value is a an object, `false` otherwise.
- */
-export declare function isObject(value: JSONValue): value is JSONObject;
-export declare function isObject(value: PartialJSONValue): value is PartialJSONObject;
-/**
- * Compare two JSON values for deep equality.
- *
- * @param first - The first JSON value of interest.
- *
- * @param second - The second JSON value of interest.
- *
- * @returns `true` if the values are equivalent, `false` otherwise.
- */
-export declare function deepEqual(first: ReadonlyPartialJSONValue, second: ReadonlyPartialJSONValue): boolean;
-/**
- * Create a deep copy of a JSON value.
- *
- * @param value - The JSON value to copy.
- *
- * @returns A deep copy of the given JSON value.
- */
-export declare function deepCopy<T extends ReadonlyPartialJSONValue>(value: T): T;
-//# sourceMappingURL=json.d.ts.map

package/es/json.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"json.d.ts","sourceRoot":"","sources":["../src/json.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,aAAa,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GAAG,SAAS,EAAE,CAAC;AAEnF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,SAAS,EAAE,CAAC;AAEpC;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC;AAE7E;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,SAAS,iBAAiB,EAAE,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB,aAAa,GACb,QAAQ,CAAC;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB,CAAA;CAAE,CAAC,GAC9C,SAAS,iBAAiB,EAAE,CAAC;AAEjC;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GACxB,aAAa,GACb,OAAO,CAAC;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,CAAA;CAAE,CAAC,GAC5C,gBAAgB,EAAE,CAAC;AAEvB;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,gBAAgB,EAAE,CAAC;AAElD;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,gBAAgB,GAAG,SAAS,CAAC,CAAC;AAE7E;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG,QAAQ,CAC9C,MAAM,CAAC,MAAM,EAAE,wBAAwB,GAAG,SAAS,CAAC,CACrD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG,SAAS,wBAAwB,EAAE,CAAC;AAE3E;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAChC,aAAa,GACb;IAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,wBAAwB,GAAG,SAAS,CAAA;CAAE,GAChE,SAAS,wBAAwB,EAAE,CAAC;AAExC;;GAEG;AACH,eAAO,MAAM,WAAW,6CAA0C,CAAC;AAEnE;;GAEG;AACH,eAAO,MAAM,UAAU,mBAAyC,CAAC;AAEjE;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,wBAAwB,GAAG,KAAK,IAAI,aAAa,CAOnF;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,SAAS,GAAG,KAAK,IAAI,SAAS,CAAC;AAE9D,wBAAgB,OAAO,CAAC,KAAK,EAAE,gBAAgB,GAAG,KAAK,IAAI,gBAAgB,CAAC;AAC5E,wBAAgB,OAAO,CACrB,KAAK,EAAE,wBAAwB,GAC9B,KAAK,IAAI,wBAAwB,CAAC;AAKrC;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,SAAS,GAAG,KAAK,IAAI,UAAU,CAAC;AAEhE,wBAAgB,QAAQ,CAAC,KAAK,EAAE,gBAAgB,GAAG,KAAK,IAAI,iBAAiB,CAAC;AAM9E;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CACvB,KAAK,EAAE,wBAAwB,EAC/B,MAAM,EAAE,wBAAwB,GAC/B,OAAO,CAiCT;AAED;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,wBAAwB,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAaxE"}

package/es/path.d.ts

@@ -1,97 +0,0 @@
-/**
- * The namespace for path-related functions.
- *
- * Note that Jupyter server paths do not start with a leading slash.
- */
-export declare namespace PathExt {
-    /**
-     * Join all arguments together and normalize the resulting path.
-     * Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown.
-     *
-     * @param paths - The string paths to join.
-     */
-    function join(...paths: string[]): string;
-    /**
-     * Return the last portion of a path. Similar to the Unix basename command.
-     * Often used to extract the file name from a fully qualified path.
-     *
-     * @param path - The path to evaluate.
-     *
-     * @param ext - An extension to remove from the result.
-     */
-    function basename(path: string, ext?: string): string;
-    /**
-     * Get the directory name of a path, similar to the Unix dirname command.
-     * When an empty path is given, returns the root path.
-     *
-     * @param path - The file path.
-     */
-    function dirname(path: string): string;
-    /**
-     * Get the extension of the path.
-     *
-     * @param path - The file path.
-     *
-     * @returns the extension of the file.
-     *
-     * #### Notes
-     * The extension is the string from the last occurrence of the `.`
-     * character to end of string in the last portion of the path, inclusive.
-     * If there is no `.` in the last portion of the path, or if the first
-     * character of the basename of path [[basename]] is `.`, then an
-     * empty string is returned.
-     */
-    function extname(path: string): string;
-    /**
-     * Normalize a string path, reducing '..' and '.' parts.
-     * When multiple slashes are found, they're replaced by a single one; when the path contains a trailing slash, it is preserved. On Windows backslashes are used.
-     * When an empty path is given, returns the root path.
-     *
-     * @param path - The string path to normalize.
-     */
-    function normalize(path: string): string;
-    /**
-     * Resolve a sequence of paths or path segments into an absolute path.
-     * The root path in the application has no leading slash, so it is removed.
-     *
-     * @param parts - The paths to join.
-     *
-     * #### Notes
-     * The right-most parameter is considered {to}.  Other parameters are considered an array of {from}.
-     *
-     * Starting from leftmost {from} parameter, resolves {to} to an absolute path.
-     *
-     * If {to} isn't already absolute, {from} arguments are prepended in right to left order, until an absolute path is found. If after using all {from} paths still no absolute path is found, the current working directory is used as well. The resulting path is normalized, and trailing slashes are removed unless the path gets resolved to the root directory.
-     */
-    function resolve(...parts: string[]): string;
-    /**
-     * Solve the relative path from {from} to {to}.
-     *
-     * @param from - The source path.
-     *
-     * @param to - The target path.
-     *
-     * #### Notes
-     * If from and to each resolve to the same path (after calling
-     * path.resolve() on each), a zero-length string is returned.
-     * If a zero-length string is passed as from or to, `/`
-     * will be used instead of the zero-length strings.
-     */
-    function relative(from: string, to: string): string;
-    /**
-     * Normalize a file extension to be of the type `'.foo'`.
-     *
-     * @param extension - the file extension.
-     *
-     * #### Notes
-     * Adds a leading dot if not present and converts to lower case.
-     */
-    function normalizeExtension(extension: string): string;
-    /**
-     * Remove the leading slash from a path.
-     *
-     * @param path: the path from which to remove a leading slash.
-     */
-    function removeSlash(path: string): string;
-}
-//# sourceMappingURL=path.d.ts.map

package/es/path.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"path.d.ts","sourceRoot":"","sources":["../src/path.ts"],"names":[],"mappings":"AAKA;;;;GAIG;AACH,yBAAiB,OAAO,CAAC;IACvB;;;;;OAKG;IACH,SAAgB,IAAI,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAG/C;IAED;;;;;;;OAOG;IACH,SAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAE3D;IAED;;;;;OAKG;IACH,SAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAG5C;IAED;;;;;;;;;;;;;OAaG;IACH,SAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE5C;IAED;;;;;;OAMG;IACH,SAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAK9C;IAED;;;;;;;;;;;;OAYG;IACH,SAAgB,OAAO,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAElD;IAED;;;;;;;;;;;;OAYG;IACH,SAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,CAEzD;IAED;;;;;;;OAOG;IACH,SAAgB,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAK5D;IAED;;;;OAIG;IACH,SAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAKhD;CACF"}

package/es/polling/index.d.ts

@@ -1,3 +0,0 @@
-export { Poll } from './poll.js';
-export * from './protocol.js';
-//# sourceMappingURL=index.d.ts.map

package/es/polling/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/polling/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,cAAc,eAAe,CAAC"}

package/es/polling/poll.d.ts

@@ -1,193 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-import type { Event } from '@difizen/mana-common';
-import { Emitter, Deferred } from '@difizen/mana-common';
-import type { IPoll } from './protocol.js';
-/**
- * A class that wraps an asynchronous function to poll at a regular interval
- * with exponential increases to the interval length if the poll fails.
- *
- * @typeparam T - The resolved type of the factory's promises.
- * Defaults to `any`.
- *
- * @typeparam U - The rejected type of the factory's promises.
- * Defaults to `any`.
- *
- * @typeparam V - An optional type to extend the phases supported by a poll.
- * Defaults to `standby`, which already exists in the `Phase` type.
- */
-export declare class Poll<T = any, U = any, V extends string = 'standby'> implements IPoll<T, U, V> {
-    protected disposeEmitter: Emitter<void>;
-    protected _factory: Poll.Factory<T, U, V>;
-    protected _frequency: IPoll.Frequency;
-    protected _standby: Poll.Standby | (() => boolean | Poll.Standby);
-    protected _state: IPoll.State<T, U, V>;
-    protected _tick: Deferred<this>;
-    protected tickedEmitter: Emitter<IPoll.State<T, U, V>>;
-    protected _timeout?: NodeJS.Timeout | undefined;
-    disposed: boolean;
-    /**
-     * Instantiate a new poll with exponential backoff in case of failure.
-     *
-     * @param options - The poll instantiation options.
-     */
-    constructor(options: Poll.IOptions<T, U, V>);
-    /**
-     * The name of the poll.
-     */
-    readonly name: string;
-    /**
-     * A signal emitted when the poll is disposed.
-     */
-    get onDispose(): Event<void>;
-    /**
-     * The polling frequency parameters.
-     */
-    get frequency(): IPoll.Frequency;
-    set frequency(frequency: IPoll.Frequency);
-    /**
-     * Whether the poll is disposed.
-     */
-    get isDisposed(): boolean;
-    /**
-     * Indicates when the poll switches to standby.
-     */
-    get standby(): Poll.Standby | (() => boolean | Poll.Standby);
-    set standby(standby: Poll.Standby | (() => boolean | Poll.Standby));
-    /**
-     * The poll state, which is the content of the current poll tick.
-     */
-    get state(): IPoll.State<T, U, V>;
-    /**
-     * A promise that resolves when the poll next ticks.
-     */
-    get tick(): Promise<this>;
-    /**
-     * A signal emitted when the poll ticks and fires off a new request.
-     */
-    get ticked(): Event<IPoll.State<T, U, V>>;
-    /**
-     * Return an async iterator that yields every tick.
-     */
-    [Symbol.asyncIterator](): AsyncIterableIterator<IPoll.State<T, U, V>>;
-    /**
-     * Dispose the poll.
-     */
-    dispose(): void;
-    /**
-     * Refreshes the poll. Schedules `refreshed` tick if necessary.
-     *
-     * @returns A promise that resolves after tick is scheduled and never rejects.
-     *
-     * #### Notes
-     * The returned promise resolves after the tick is scheduled, but before
-     * the polling action is run. To wait until after the poll action executes,
-     * await the `poll.tick` promise: `await poll.refresh(); await poll.tick;`
-     */
-    refresh(): Promise<void>;
-    /**
-     * Schedule the next poll tick.
-     *
-     * @param next - The next poll state data to schedule. Defaults to standby.
-     *
-     * @param next.cancel - Cancels state transition if function returns `true`.
-     *
-     * @returns A promise that resolves when the next poll state is active.
-     *
-     * #### Notes
-     * This method is not meant to be invoked by user code typically. It is public
-     * to allow poll instances to be composed into classes that schedule ticks.
-     */
-    schedule(next?: Partial<IPoll.State<T, U, V> & {
-        cancel: (last: IPoll.State<T, U, V>) => boolean;
-    }>): Promise<void>;
-    /**
-     * Starts the poll. Schedules `started` tick if necessary.
-     *
-     * @returns A promise that resolves after tick is scheduled and never rejects.
-     */
-    start(): Promise<void>;
-    /**
-     * Stops the poll. Schedules `stopped` tick if necessary.
-     *
-     * @returns A promise that resolves after tick is scheduled and never rejects.
-     */
-    stop(): Promise<void>;
-    /**
-     * Execute a new poll factory promise or stand by if necessary.
-     */
-    protected _execute(): void;
-}
-/**
- * A namespace for `Poll` types, interfaces, and statics.
- */
-export declare namespace Poll {
-    /**
-     * A promise factory that returns an individual poll request.
-     *
-     * @typeparam T - The resolved type of the factory's promises.
-     *
-     * @typeparam U - The rejected type of the factory's promises.
-     *
-     * @typeparam V - The type to extend the phases supported by a poll.
-     */
-    type Factory<T, U, V extends string> = (state: IPoll.State<T, U, V>) => Promise<T>;
-    /**
-     * Indicates when the poll switches to standby.
-     */
-    type Standby = 'never' | 'when-hidden';
-    /**
-     * Instantiation options for polls.
-     *
-     * @typeparam T - The resolved type of the factory's promises.
-     *
-     * @typeparam U - The rejected type of the factory's promises.
-     *
-     * @typeparam V - The type to extend the phases supported by a poll.
-     */
-    interface IOptions<T, U, V extends string> {
-        /**
-         * Whether to begin polling automatically; defaults to `true`.
-         */
-        auto?: boolean;
-        /**
-         * A factory function that is passed a poll tick and returns a poll promise.
-         */
-        factory: Factory<T, U, V>;
-        /**
-         * The polling frequency parameters.
-         */
-        frequency?: Partial<IPoll.Frequency>;
-        /**
-         * The name of the poll.
-         * Defaults to `'unknown'`.
-         */
-        name?: string;
-        /**
-         * Indicates when the poll switches to standby or a function that returns
-         * a boolean or a `Poll.Standby` value to indicate whether to stand by.
-         * Defaults to `'when-hidden'`.
-         *
-         * #### Notes
-         * If a function is passed in, for any given context, it should be
-         * idempotent and safe to call multiple times. It will be called before each
-         * tick execution, but may be called by clients as well.
-         */
-        standby?: Standby | (() => boolean | Standby);
-    }
-    /**
-     * An interval value (0ms) that indicates the poll should tick immediately.
-     */
-    const IMMEDIATE = 0;
-    /**
-     * Delays are 32-bit integers in many browsers so intervals need to be capped.
-     *
-     * #### Notes
-     * https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/setTimeout#Maximum_delay_value
-     */
-    const MAX_INTERVAL = 2147483647;
-    /**
-     * An interval value that indicates the poll should never tick.
-     */
-    const NEVER: number;
-}
-//# sourceMappingURL=poll.d.ts.map

package/es/polling/poll.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"poll.d.ts","sourceRoot":"","sources":["../../src/polling/poll.ts"],"names":[],"mappings":";AAIA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAIzD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAE3C;;;;;;;;;;;;GAYG;AACH,qBAAa,IAAI,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,SAAS,MAAM,GAAG,SAAS,CAC9D,YAAW,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAEzB,SAAS,CAAC,cAAc,gBAAuB;IAC/C,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1C,SAAS,CAAC,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC;IACtC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,GAAG,CAAC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;IAClE,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACvC,SAAS,CAAC,KAAK,iBAAwB;IACvC,SAAS,CAAC,aAAa,gCAAuC;IAC9D,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;IAChD,QAAQ,UAAS;IACjB;;;;OAIG;gBACS,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAyB3C;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,SAAS,IAAI,KAAK,CAAC,IAAI,CAAC,CAE3B;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,KAAK,CAAC,SAAS,CAE/B;IACD,IAAI,SAAS,CAAC,SAAS,EAAE,KAAK,CAAC,SAAS,EAwBvC;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,OAAO,CAExB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,IAAI,CAAC,OAAO,GAAG,CAAC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,CAE3D;IACD,IAAI,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,GAAG,CAAC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,EAMjE;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAEhC;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAExB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAExC;IAED;;OAEG;IACI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,qBAAqB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAO5E;;OAEG;IACH,OAAO,IAAI,IAAI;IAiBf;;;;;;;;;OASG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAQxB;;;;;;;;;;;;OAYG;IACG,QAAQ,CACZ,IAAI,GAAE,OAAO,CACX,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG;QAAE,MAAM,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,OAAO,CAAA;KAAE,CACtE,GACL,OAAO,CAAC,IAAI,CAAC;IA+ChB;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAStB;;;;OAIG;IACH,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAQrB;;OAEG;IACH,SAAS,CAAC,QAAQ,IAAI,IAAI;CAyC3B;AAED;;GAEG;AACH,yBAAiB,IAAI,CAAC;IACpB;;;;;;;;OAQG;IACH,KAAY,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,MAAM,IAAI,CAC5C,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KACxB,OAAO,CAAC,CAAC,CAAC,CAAC;IAEhB;;OAEG;IACH,KAAY,OAAO,GAAG,OAAO,GAAG,aAAa,CAAC;IAE9C;;;;;;;;OAQG;IACH,UAAiB,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,MAAM;QAC9C;;WAEG;QACH,IAAI,CAAC,EAAE,OAAO,CAAC;QAEf;;WAEG;QACH,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAE1B;;WAEG;QACH,SAAS,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAErC;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;;;;;;;WASG;QACH,OAAO,CAAC,EAAE,OAAO,GAAG,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC;KAC/C;IACD;;OAEG;IACI,MAAM,SAAS,IAAI,CAAC;IAE3B;;;;;OAKG;IACI,MAAM,YAAY,aAAa,CAAC;IAEvC;;OAEG;IACI,MAAM,KAAK,QAAW,CAAC;CAC/B"}