Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default<CTX>

Type parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new default<CTX>(ctx?: CTX): default<CTX>

Properties

Protected Readonly cache

cache: Dictionary<GlobalCache> = ...

Cache for async operations

Protected Readonly context

context: CTX
deprecated
see

[[Async.ctx]]

Protected Readonly ctx

ctx: CTX

Context of applying for async handlers

Protected Readonly idsMap

idsMap: WeakMap<object, object> = ...

Map for task identifiers

locked

locked: boolean = false

The lock status. If true, then all new tasks won't be registered.

Protected Readonly usedNamespaces

usedNamespaces: Set<string> = ...

Set of used async namespaces

Protected Readonly workerCache

workerCache: WeakMap<object, boolean> = ...

Cache for initialized workers

Static linkNames

linkNames: { eventListener: "eventListener"; eventListenerPromise: "eventListenerPromise"; idleCallback: "idleCallback"; idleCallbackPromise: "idleCallbackPromise"; immediate: "immediate"; immediatePromise: "immediatePromise"; interval: "interval"; intervalPromise: "intervalPromise"; iterable: "iterable"; promise: "promise"; proxy: "proxy"; proxyPromise: "proxyPromise"; request: "request"; timeout: "timeout"; timeoutPromise: "timeoutPromise"; worker: "worker" } = namespaces
deprecated
see

Async.namespaces

Type declaration

  • eventListener: "eventListener"
  • eventListenerPromise: "eventListenerPromise"
  • idleCallback: "idleCallback"
  • idleCallbackPromise: "idleCallbackPromise"
  • immediate: "immediate"
  • immediatePromise: "immediatePromise"
  • interval: "interval"
  • intervalPromise: "intervalPromise"
  • iterable: "iterable"
  • promise: "promise"
  • proxy: "proxy"
  • proxyPromise: "proxyPromise"
  • request: "request"
  • timeout: "timeout"
  • timeoutPromise: "timeoutPromise"
  • worker: "worker"

Static namespaces

namespaces: { eventListener: "eventListener"; eventListenerPromise: "eventListenerPromise"; idleCallback: "idleCallback"; idleCallbackPromise: "idleCallbackPromise"; immediate: "immediate"; immediatePromise: "immediatePromise"; interval: "interval"; intervalPromise: "intervalPromise"; iterable: "iterable"; promise: "promise"; proxy: "proxy"; proxyPromise: "proxyPromise"; request: "request"; timeout: "timeout"; timeoutPromise: "timeoutPromise"; worker: "worker" } = namespaces

Map of namespaces for async operations

Type declaration

  • eventListener: "eventListener"
  • eventListenerPromise: "eventListenerPromise"
  • idleCallback: "idleCallback"
  • idleCallbackPromise: "idleCallbackPromise"
  • immediate: "immediate"
  • immediatePromise: "immediatePromise"
  • interval: "interval"
  • intervalPromise: "intervalPromise"
  • iterable: "iterable"
  • promise: "promise"
  • proxy: "proxy"
  • proxyPromise: "proxyPromise"
  • request: "request"
  • timeout: "timeout"
  • timeoutPromise: "timeoutPromise"
  • worker: "worker"

Accessors

Protected linkNames

  • get linkNames(): { eventListener: "eventListener"; eventListenerPromise: "eventListenerPromise"; idleCallback: "idleCallback"; idleCallbackPromise: "idleCallbackPromise"; immediate: "immediate"; immediatePromise: "immediatePromise"; interval: "interval"; intervalPromise: "intervalPromise"; iterable: "iterable"; promise: "promise"; proxy: "proxy"; proxyPromise: "proxyPromise"; request: "request"; timeout: "timeout"; timeoutPromise: "timeoutPromise"; worker: "worker" }
  • deprecated
    see

    [[Async.namespaces]]

    Returns { eventListener: "eventListener"; eventListenerPromise: "eventListenerPromise"; idleCallback: "idleCallback"; idleCallbackPromise: "idleCallbackPromise"; immediate: "immediate"; immediatePromise: "immediatePromise"; interval: "interval"; intervalPromise: "intervalPromise"; iterable: "iterable"; promise: "promise"; proxy: "proxy"; proxyPromise: "proxyPromise"; request: "request"; timeout: "timeout"; timeoutPromise: "timeoutPromise"; worker: "worker" }

    • eventListener: "eventListener"
    • eventListenerPromise: "eventListenerPromise"
    • idleCallback: "idleCallback"
    • idleCallbackPromise: "idleCallbackPromise"
    • immediate: "immediate"
    • immediatePromise: "immediatePromise"
    • interval: "interval"
    • intervalPromise: "intervalPromise"
    • iterable: "iterable"
    • promise: "promise"
    • proxy: "proxy"
    • proxyPromise: "proxyPromise"
    • request: "request"
    • timeout: "timeout"
    • timeoutPromise: "timeoutPromise"
    • worker: "worker"

Protected namespaces

  • get namespaces(): { eventListener: "eventListener"; eventListenerPromise: "eventListenerPromise"; idleCallback: "idleCallback"; idleCallbackPromise: "idleCallbackPromise"; immediate: "immediate"; immediatePromise: "immediatePromise"; interval: "interval"; intervalPromise: "intervalPromise"; iterable: "iterable"; promise: "promise"; proxy: "proxy"; proxyPromise: "proxyPromise"; request: "request"; timeout: "timeout"; timeoutPromise: "timeoutPromise"; worker: "worker" }

  • Link to Async.namespaces

    Returns { eventListener: "eventListener"; eventListenerPromise: "eventListenerPromise"; idleCallback: "idleCallback"; idleCallbackPromise: "idleCallbackPromise"; immediate: "immediate"; immediatePromise: "immediatePromise"; interval: "interval"; intervalPromise: "intervalPromise"; iterable: "iterable"; promise: "promise"; proxy: "proxy"; proxyPromise: "proxyPromise"; request: "request"; timeout: "timeout"; timeoutPromise: "timeoutPromise"; worker: "worker" }

    • eventListener: "eventListener"
    • eventListenerPromise: "eventListenerPromise"
    • idleCallback: "idleCallback"
    • idleCallbackPromise: "idleCallbackPromise"
    • immediate: "immediate"
    • immediatePromise: "immediatePromise"
    • interval: "interval"
    • intervalPromise: "intervalPromise"
    • iterable: "iterable"
    • promise: "promise"
    • proxy: "proxy"
    • proxyPromise: "proxyPromise"
    • request: "request"
    • timeout: "timeout"
    • timeoutPromise: "timeoutPromise"
    • worker: "worker"

Methods

cancelIterable

  • Cancels the specified iterable object. Notice that cancellation affects only objects that have already been activated by invoking the next method. So, for example, canceled iterable will throw an error on the next invoking of next.

    alias

    Parameters

    • Optional id: AsyncIterable<unknown>

    Returns default<CTX>

  • Cancels the specified iterable or a group of iterable. Notice that cancellation affects only objects that have already been activated by invoking the next method. So, for example, canceled iterable will throw an error on the next invoking of next.

    alias

    Parameters

    • opts: ClearOptionsId<AsyncIterable<unknown>>

      options for the operation

    Returns default<CTX>

cancelPromise

cancelProxy

cancelRequest

Protected cancelTask

  • cancelTask(task: any, name?: string): default<CTX>

clearAll

Protected clearAsync

  • clearAsync(opts: any, name?: string): default<CTX>

clearIterable

  • Cancels the specified iterable object. Notice that cancellation affects only objects that have already been activated by invoking the next method. So, for example, canceled iterable will throw an error on the next invoking of next.

    Parameters

    • Optional id: Promise<unknown>

    Returns default<CTX>

  • Cancels the specified iterable object. Notice that cancellation affects only objects that have already been activated by invoking the next method. So, for example, canceled iterable will throw an error on the next invoking of next.

    Parameters

    Returns default<CTX>

clearPromise

clearProxy

clearRequest

clearWorker

debounce

Protected getBaseIterator

  • getBaseIterator<T>(iterable: Iterable<T> | AsyncIterable<T>): CanUndef<IterableIterator<T> | AsyncIterableIterator<T>>

  • Returns an iterator from the passed iterable object. Notice, an asynchronous iterator has more priority.

    Type parameters

    • T

    Parameters

    • iterable: Iterable<T> | AsyncIterable<T>

    Returns CanUndef<IterableIterator<T> | AsyncIterableIterator<T>>

Protected getCache

Protected initCache

  • initCache(name: string, promise?: boolean): GlobalCache

iterable

  • iterable<T>(iterable: Iterable<T> | AsyncIterable<T>, opts?: AsyncOptions): AsyncIterable<T> | (AsyncIterable<T> & Iterable<T>)

  • Creates a new asynchronous iterable object from the specified iterable and returns it. If the passed iterable doesn't have Symbol.asyncIterator, it will be created from a synchronous object iterator (the synchronous iterator will also be preserved).

    Notice, until the created promise object isn't executed by invoking the next method, any async operations won't be registered.

    example
    const async = new Async();

    for await (const el of async.iterable([1, 2, 3, 4])) {
      console.log(el);
    }

    Type parameters

    • T

    Parameters

    • iterable: Iterable<T> | AsyncIterable<T>
    • Optional opts: AsyncOptions

    Returns AsyncIterable<T> | (AsyncIterable<T> & Iterable<T>)

Protected markAllTasks

Protected markAsync

  • markAsync(label: string, opts: any, name?: string): default<CTX>

Protected markPromise

  • markPromise(label: string, id?: Promise<unknown>): default<CTX>
  • markPromise(label: string, opts: ClearOptionsId<Promise<unknown>>): default<CTX>

Protected markTask

  • markTask(label: string, task: any, name?: string): default<CTX>

muteAll

muteIterable

  • Mutes the specified iterable object. Elements that are consumed during the object is muted will be ignored. Notice that muting affects only objects that have already been activated by invoking the next method.

    Parameters

    • Optional id: AsyncIterable<unknown>

    Returns default<CTX>

  • Mutes the specified iterable object or a group of iterable objects. Elements, that are consumed during the object is muted will be ignored. Notice that muting affects only objects that have already been activated by invoking the next method.

    Parameters

    • opts: ClearOptionsId<AsyncIterable<unknown>>

      options for the operation

    Returns default<CTX>

mutePromise

muteProxy

muteRequest

onPromiseClear

  • onPromiseClear(resolve: Function, reject: Function): Function

onPromiseMerge

  • onPromiseMerge(resolve: Function, reject: Function): Function

promise

  • Creates a new promise that wraps the passed promise and returns it.

    This method doesn't attach any hook or listeners to the object, but if we cancel the operation by using one of Async's methods, like, "cancelPromise", the promise will be rejected.

    The promise can be provided as it is or as a function, that returns a promise.

    example
    const
      async = new Async();

    async.promise(new Promise(() => {
      // ...
    }))

    Type parameters

    • T = unknown

    Parameters

    Returns Promise<T>

promiseDestructor

proxy

  • Creates a new function that wraps the original and returns it.

    This method doesn't attach any hook or listeners to the object, but if we cancel the operation by using one of Async's methods, like, cancelProxy, the target function won't be invoked.

    example
    const
      async = new Async();

    myImage.onload = async.proxy(() => {
      // ...
    });

    Type parameters

    Parameters

    Returns F

Protected registerTask

request

  • request<T>(request: (() => PromiseLike<T>) | PromiseLike<T>, opts?: AsyncRequestOptions): Promise<T>

  • Creates a promise that wraps the passed request and returns it.

    This method doesn't attach any hook or listeners to the object, but if we cancel the operation by using one of Async's methods, like, "cancelRequest", the promise will be rejected.

    The request can be provided as a promise or function, that returns a promise. Notice, the method uses Async.promise, but with a different namespace: request instead of promise.

    example
    const async = new Async();
    async.request(fetch('foo/bla'));

    Type parameters

    • T = unknown

    Parameters

    Returns Promise<T>

Protected setAsync

suspendAll

suspendIterable

  • Suspends the specified iterable object. Notice that suspending affects only objects that have already been activated by invoking the next method.

    Parameters

    • Optional id: AsyncIterable<unknown>

    Returns default<CTX>

  • Suspends the specified iterable or a group of iterable objects. Notice that suspending affects only objects that have already been activated by invoking the next method.

    Parameters

    • opts: ClearOptionsId<AsyncIterable<unknown>>

      options for the operation

    Returns default<CTX>

suspendPromise

suspendProxy

suspendRequest

terminateWorker

throttle

unmuteAll

unmuteIterable

unmutePromise

unmuteProxy

unmuteRequest

unsuspendAll

unsuspendIterable

unsuspendPromise

unsuspendProxy

unsuspendRequest

worker

  • Wraps the specified worker object.

    This method doesn't attach any hook or listeners to the object, but every time the same object is registered, Async will increment the number of links that relate to this object. After, when we try to destroy the worker by using one of Async's methods, like, terminateWorker, it will de-increment values of links. When the number of links is equal to zero, Async will try to call a "real" object destructor by using one of the possible destructor methods from the whitelist or by the specified destructor name, also if the worker is a function, it is interpreted as the destructor.

    example
    const
      async = new Async(),
      el = document.createElement('div');

    $el.appendChild(el);

    // This function will work as the worker destructor
    async.worker(() => el.remove());

    const
      myWorker = new Worker('my-worker.js');

    async.worker(myWorker);

    async.clearAll();

    Type parameters

    Parameters

    Returns T

workerDestructor