Interface Binding<GetType>

A binding is a stored piece of data that notifies registered listeners when changed.

See

useBinding

interface Binding<GetType> {
    addChangeListener: ((listener) => ChangeListenerRemover);
    get: (() => GetType);
    getChangeUid: (() => string);
    id: string;
    isBinding: true;
    isLocked: (() => boolean);
    isModified: (() => boolean);
    lock: (() => (() => void));
    reset: (() => void);
    set: ((newValue) => void);
    setIsModified: ((isModified) => void);
    setRaw: ((newValue) => void);
    setValueTransformer?: SetValueTransformer<GetType>;
    triggerChangeListeners: (() => void);
    uid: string;
}

Type Parameters

  • GetType = any

Hierarchy (view full)

Properties

addChangeListener get getChangeUid id isBinding isLocked isModified lock reset set setIsModified setRaw setValueTransformer? triggerChangeListeners uid

Properties

Readonly addChangeListener

addChangeListener: ((listener) => ChangeListenerRemover)

Adds a listener that will be called when this binding changes.

Type declaration

See

useBindingEffect and BindingsConsumer

Returns

a function that may be used to remove the added listener.

Readonly get

get: (() => GetType)

Type declaration

Returns

the value

Readonly getChangeUid

getChangeUid: (() => string)

Every time the value is changed, the change uid is updated

Type declaration

    • (): string

    • Every time the value is changed, the change uid is updated

      Returns string

Readonly id

id: string

A technical, but human-readable ID, which isn't guaranteed to be unique

Readonly isBinding

isBinding: true

A marker indicating that this is a binding type

Readonly isLocked

isLocked: (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

      true if the binding is locked

Returns

true if the binding is locked

Readonly isModified

isModified: (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

      true if this binding has been marked as being modified

Returns

true if this binding has been marked as being modified

Readonly lock

lock: (() => (() => void))

Increments the lock count and returns a method to decrement it. A binding is locked if its lock count is > 0. When a binding is locked, mutating calls (reset/set/setRaw) won't have an immediate effect. However, if a mutating call is made on a locked binding, the change will be applied once the binding becomes unlocked.

Type declaration

    • (): (() => void)

    • Increments the lock count and returns a method to decrement it. A binding is locked if its lock count is > 0. When a binding is locked, mutating calls (reset/set/setRaw) won't have an immediate effect. However, if a mutating call is made on a locked binding, the change will be applied once the binding becomes unlocked.

      Returns (() => void)

      a function for decrementing this binding's lock count.

        • (): void

        • Returns void

Returns

a function for decrementing this binding's lock count.

Readonly reset

reset: (() => void)

Resets the binding back to its initial value and marks the binding as non-modified.

Type declaration

    • (): void

    • Resets the binding back to its initial value and marks the binding as non-modified.

      Returns void

Readonly set

set: ((newValue) => void)

Sets the value, using the result of setValueTransformer if set, and then marks the binding as modified.

Type declaration

    • (newValue): void

    • Sets the value, using the result of setValueTransformer if set, and then marks the binding as modified.

      Parameters

      Returns void

Readonly setIsModified

setIsModified: ((isModified) => void)

Sets the binding as having been modified or not

Type declaration

    • (isModified): void

    • Sets the binding as having been modified or not

      Parameters

      • isModified: boolean

      Returns void

Readonly setRaw

setRaw: ((newValue) => void)

Sets the internal value without transforming or marking as changed. Don't normally use this!

Type declaration

    • (newValue): void

    • Sets the internal value without transforming or marking as changed. Don't normally use this!

      Parameters

      Returns void

Optional Readonly setValueTransformer

setValueTransformer?: SetValueTransformer<GetType>

If set, a function to transform the value before it's stored

Readonly triggerChangeListeners

triggerChangeListeners: (() => void)

Forcibly triggers the change listeners. Don't normally use this!

Type declaration

    • (): void

    • Forcibly triggers the change listeners. Don't normally use this!

      Returns void

Readonly uid

uid: string

An ID that's unique to this runtime

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc