Interface Readable<T>

Represents a value in the Mod API that can be accessed and/or modified. These values can be used when creating an instance of a Reader via the Mod.createReader method.

interface Readable<T> {
    [toStringTag]: string;
    __futureValue?: T;
    readableID: string;
    catch<TResult>(onrejected?: null | ((reason: any) => TResult | PromiseLike<TResult>)): Promise<T | TResult>;
    finally(onfinally?: null | (() => void)): Promise<T>;
    then<TResult1, TResult2>(onfulfilled?: null | ((value: T) => TResult1 | PromiseLike<TResult1>), onrejected?: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)): Promise<TResult1 | TResult2>;
}

Type Parameters

  • T = any

Hierarchy

  • Promise<T>
    • Readable

Properties

[toStringTag] __futureValue? readableID

Methods

catch finally then

Properties

Readonly[toStringTag]

[toStringTag]: string

Optional__futureValue

__futureValue?: T

Used internally by the Mod api.

readableID

readableID: string

Used internally by the Mod api.

Methods

catch

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

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

    Type Parameters

    • TResult = never

    Parameters

    • Optionalonrejected: null | ((reason: any) => TResult | PromiseLike<TResult>)

      The callback to execute when the Promise is rejected.

    Returns Promise<T | TResult>

    A Promise for the completion of the callback.

finally

  • finally(onfinally?): Promise<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

    • Optionalonfinally: null | (() => void)

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

    Returns Promise<T>

    A Promise for the completion of the callback.

then

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

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

    Type Parameters

    • TResult1 = T
    • TResult2 = never

    Parameters

    • Optionalonfulfilled: null | ((value: T) => TResult1 | PromiseLike<TResult1>)

      The callback to execute when the Promise is resolved.

    • Optionalonrejected: null | ((reason: any) => 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

On This Page

Properties
Methods