IFClite TypeScript API
    Preparing search index...

    Interface BindMutationsOptions

    interface BindMutationsOptions {
        onlyWhenConnected?: boolean;
        resolveEntity: (entityId: number) => string | null;
        typeNameFor?: (vt: PropertyValueType) => string;
    }
    Index
    onlyWhenConnected? resolveEntity typeNameFor?
    onlyWhenConnected?: boolean

    If true, only mirror writes when session.provider !== 'memory'. Useful when consumers want to share-bind only after the websocket upgrade has happened. Default false.

    resolveEntity: (entityId: number) => string | null

    Translate a numeric entityId into the corresponding IFCX path. Returning null skips the CRDT mirror for this mutation (the local view still updates).

    typeNameFor?: (vt: PropertyValueType) => string

    Optional translation between the legacy PropertyValueType enum and the IFCX-shaped string we store in the Y.Doc. Defaults to PROPERTY_TYPE_NAMES.

    Settings
    Member Visibility

    On This Page
    Properties