Interface ResultIterator<T>

interface ResultIterator<T> {
    [toStringTag]: string;
    [asyncIterator](): AsyncIterator<T, any, undefined>;
    catch<TResult>(onrejected?): Promise<Result<T> | TResult>;
    finally(onfinally?): Promise<Result<T>>;
    first(): Promise<undefined | T>;
    notify(done, status?): void;
    one(): Promise<T>;
    then<TResult1, TResult2>(onfulfilled?, onrejected?): Promise<TResult1 | TResult2>;
}

Type Parameters

  • T

Hierarchy

  • ResultIteratorImpl<T>
    • ResultIterator

Properties

[toStringTag]

Methods

[asyncIterator] catch finally first notify one then

Properties

Readonly [toStringTag]

[toStringTag]: string

Methods

[asyncIterator]

  • [asyncIterator](): AsyncIterator<T, any, undefined>

  • Returns AsyncIterator<T, any, undefined>

catch

  • catch<TResult>(onrejected?): Promise<Result<T> | TResult>

  • Attaches a callback for only the rejection of the Promise.

    Type Parameters

    • TResult = never

    Parameters

    • Optional onrejected: null | ((reason) => TResult | PromiseLike<TResult>)

      The callback to execute when the Promise is rejected.

    Returns Promise<Result<T> | TResult>

    A Promise for the completion of the callback.

finally

  • finally(onfinally?): Promise<Result<T>>

  • Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.

    Parameters

    • Optional onfinally: null | (() => void)

      The callback to execute when the Promise is settled (fulfilled or rejected).

    Returns Promise<Result<T>>

    A Promise for the completion of the callback.

first

  • first(): Promise<undefined | T>

  • Return the first item (if any) from the query results.

    Returns Promise<undefined | T>

notify

  • notify(done, status?): void

  • Parameters

    Returns void

one

  • one(): Promise<T>

  • Return the first item from the query results, or throw an error.

    Returns Promise<T>

then

  • then<TResult1, TResult2>(onfulfilled?, onrejected?): Promise<TResult1 | TResult2>

  • Attaches callbacks for the resolution and/or rejection of the Promise.

    Type Parameters

    • TResult1 = Result<T>
    • TResult2 = never

    Parameters

    • Optional onfulfilled: null | ((value) => TResult1 | PromiseLike<TResult1>)

      The callback to execute when the Promise is resolved.

    • Optional onrejected: null | ((reason) => TResult2 | PromiseLike<TResult2>)

      The callback to execute when the Promise is rejected.

    Returns Promise<TResult1 | TResult2>

    A Promise for the completion of which ever callback is executed.

Settings

Member Visibility

Theme

On This Page

[toStringTag][asyncIterator]catchfinallyfirstnotifyonethen