Interface Context<T>

A context.

interface Context<T> {
    apply<R>(fn: (() => R), value: T): R;
    applyComputed<R>(fn: (() => R), valueFn: (() => T)): R;
    get(node: object): T;
    getDefault(): T;
    getProviderNode(node: object): undefined | object;
    set(node: object, value: T): void;
    setComputed(node: object, valueFn: (() => T)): void;
    setDefault(value: T): void;
    setDefaultComputed(valueFn: (() => T)): void;
    unset(node: object): void;
}

Type Parameters

  • T

Methods

apply applyComputed get getDefault getProviderNode set setComputed setDefault setDefaultComputed unset

Methods

apply

  • apply<R>(fn, value): R

  • Applies a value override while the given function is running and, if a node is returned, sets the node as a provider of the value.

    Type Parameters

    • R

    Parameters

    • fn: (() => R)

      Function to run.

        • (): R

        • Returns R

    • value: T

      Value to apply.

    Returns R

    The value returned from the function.

    Typeparam

    R

applyComputed

  • applyComputed<R>(fn, valueFn): R

  • Applies a computed value override while the given function is running and, if a node is returned, sets the node as a provider of the computed value.

    Type Parameters

    • R

    Parameters

    • fn: (() => R)

      Function to run.

        • (): R

        • Returns R

    • valueFn: (() => T)
        • (): T

        • Returns T

    Returns R

    The value returned from the function.

    Typeparam

    R

get

  • get(node): T

  • Gets the context value for a given node.

    Parameters

    • node: object

    Returns T

getDefault

  • getDefault(): T

  • Gets the context default value.

    Returns T

getProviderNode

  • getProviderNode(node): undefined | object

  • Gets node that will provide the context value, or undefined if it comes from the default.

    Parameters

    • node: object

    Returns undefined | object

set

  • set(node, value): void

  • Sets the context value for a given node, effectively making it a provider.

    Parameters

    • node: object
    • value: T

    Returns void

setComputed

  • setComputed(node, valueFn): void

  • Sets the context value resolver for a given node, effectively making it a provider.

    Parameters

    • node: object
    • valueFn: (() => T)
        • (): T

        • Returns T

    Returns void

setDefault

  • setDefault(value): void

  • Sets the context default value.

    Parameters

    • value: T

    Returns void

setDefaultComputed

  • setDefaultComputed(valueFn): void

  • Sets the context default value resolver.

    Parameters

    • valueFn: (() => T)
        • (): T

        • Returns T

    Returns void

unset

  • unset(node): void

  • Unsets the context value for a given node, therefore it won't be a provider anymore.

    Parameters

    • node: object

    Returns void

Settings

Member Visibility

On This Page

Methods