Interface Context

The Context is available in conversion functions.

interface Context {
    ignore(): void;
    newValue(): any;
    newValues(): any[];
    oldValue(): any;
    oldValues(): any[];
    promiseValue<T>(candidate: PromiseLike<T>): any;
    source: Bindable<PropertyName>;
    sourceName: PropertyName;
    sourceNames: readonly PropertyName[];
    target: Bindable<PropertyName>;
    targetName: PropertyName;
    targetNames: readonly PropertyName[];
    targetValue(): any;
    targetValues(): any;
}

Properties

source sourceName sourceNames target targetName targetNames

Methods

ignore newValue newValues oldValue oldValues promiseValue targetValue targetValues

Properties

Readonlysource

source: Bindable<PropertyName>

The source bindable.

ReadonlysourceName

sourceName: PropertyName

The property name on the source side (for single source property).

ReadonlysourceNames

sourceNames: readonly PropertyName[]

The property names on the source side (for multiple source properties).

Readonlytarget

target: Bindable<PropertyName>

The target bindable.

ReadonlytargetName

targetName: PropertyName

The property name on the target side (for single source property).

ReadonlytargetNames

targetNames: readonly PropertyName[]

The property names on the target side (for multiple source properties).

Methods

ignore

  • ignore(): void

  • execute and return for avoiding mutation

    Returns void

newValue

  • newValue(): any

  • The new property value. Provided if single source property.

    Returns any

newValues

  • newValues(): any[]

  • The new property values. Provided if multiple source properties.

    Returns any[]

oldValue

  • oldValue(): any

  • The old property value. Provided if single source property.

    Returns any

oldValues

  • oldValues(): any[]

  • The old property values. Provided if multiple source properties.

    Returns any[]

promiseValue

  • promiseValue<T>(candidate: PromiseLike<T>): any

  • Wraps a promise to signal that it should be handled as plain value.

    Type Parameters

    • T

    Parameters

    • candidate: PromiseLike<T>

      a promise.

    Returns any

    a wrapper for the promise.

targetValue

  • targetValue(): any

  • The current property value on the target side. Provided if single source property.

    Returns any

targetValues

  • targetValues(): any

  • The current property values on the target side. Provided if multiple source properties.

    Returns any

Settings

Member Visibility

On This Page

Properties
Methods