Interface Factory

Factory for initializing binding instances

interface Factory {
    create<
        LeftPropName extends PropertyName = string,
        RightPropName extends PropertyName = string,
    >(): Binding<LeftPropName, RightPropName>;
    for<
        LeftPropName extends PropertyName = string,
        RightPropName extends PropertyName = string,
    >(
        left: Bindable<LeftPropName>,
        right: Bindable<RightPropName>,
    ): Binding<LeftPropName, RightPropName>;
    ignore(): typeof IGNORE;
    promiseValue<T>(candidate: PromiseLike<T>): any;
}

Index

Methods

create for ignore promiseValue

Methods

create

create<
LeftPropName extends PropertyName = string,
RightPropName extends PropertyName = string,
>(): Binding<LeftPropName, RightPropName>
Creates empty binding.
Type Parameters
- LeftPropName extends PropertyName = string
- RightPropName extends PropertyName = string
Returns Binding<LeftPropName, RightPropName>
a new binding
- Defined in Binding.ts:299

for

for<
    LeftPropName extends PropertyName = string,
    RightPropName extends PropertyName = string,
>(
    left: Bindable<LeftPropName>,
    right: Bindable<RightPropName>,
): Binding<LeftPropName, RightPropName>
Creates binding. Equivalent to Binding.create().bindTo(left, right)
Type Parameters
- LeftPropName extends PropertyName = string
- RightPropName extends PropertyName = string
Parameters
- left: Bindable<LeftPropName>
- right: Bindable<RightPropName>
Returns Binding<LeftPropName, RightPropName>
a new Binding
- Defined in Binding.ts:290

ignore

ignore(): typeof IGNORE
Produces a value which may be returned by converter functions to signal that no further processing is required.

Returns typeof IGNORE
ignore symbol.
- Defined in Binding.ts:308

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.
- Defined in Binding.ts:315