@dxos/react-client
    Preparing search index...

    Variable useObjectConst

    useObject: {
        <T extends Unknown>(
            ref: Ref<T>,
        ): [undefined | Snapshot<T>, ObjectUpdateCallback<T>];
        <T extends Unknown>(
            ref: undefined | Ref<T>,
        ): [undefined | Snapshot<T>, ObjectUpdateCallback<T>];
        <T extends Unknown>(obj: T): [Snapshot<T>, ObjectUpdateCallback<T>];
        <T extends Unknown>(
            obj: undefined | T,
        ): [undefined | Snapshot<T>, ObjectUpdateCallback<T>];
        <T extends Unknown>(
            objOrRef: T | Ref<T>,
        ): [undefined | Snapshot<T>, ObjectUpdateCallback<T>];
        <T extends Unknown, K extends string | number | symbol>(
            obj: T,
            property: K,
        ): [T[K], ObjectPropUpdateCallback<T[K]>];
        <T extends Unknown, K extends string | number | symbol>(
            obj: undefined | T,
            property: K,
        ): [undefined | T[K], ObjectPropUpdateCallback<T[K]>];
        <T, K extends string | number | symbol>(
            ref: Ref<T>,
            property: K,
        ): [undefined | T[K], ObjectPropUpdateCallback<T[K]>];
        <T, K extends string | number | symbol>(
            ref: undefined | Ref<T>,
            property: K,
        ): [undefined | T[K], ObjectPropUpdateCallback<T[K]>];
    }

    Type declaration

      • <T extends Unknown>(
            ref: Ref<T>,
        ): [undefined | Snapshot<T>, ObjectUpdateCallback<T>]

      • Hook to subscribe to a Ref's target object. Automatically dereferences the ref and handles async loading. Returns a snapshot (undefined if the ref hasn't loaded yet).

        Type Parameters

        • T extends Unknown

        Parameters

        • ref: Ref<T>

          The Ref to dereference and subscribe to

        Returns [undefined | Snapshot<T>, ObjectUpdateCallback<T>]

        The current target snapshot (or undefined if not loaded) and update callback

      • <T extends Unknown>(
            ref: undefined | Ref<T>,
        ): [undefined | Snapshot<T>, ObjectUpdateCallback<T>]

      • Hook to subscribe to a Ref's target object that may be undefined. Returns a snapshot (undefined if the ref is undefined or hasn't loaded yet).

        Type Parameters

        • T extends Unknown

        Parameters

        • ref: undefined | Ref<T>

          The Ref to dereference and subscribe to (can be undefined)

        Returns [undefined | Snapshot<T>, ObjectUpdateCallback<T>]

        The current target snapshot (or undefined) and update callback

      • <T extends Unknown>(obj: T): [Snapshot<T>, ObjectUpdateCallback<T>]

      • Hook to subscribe to an entire Echo object. Returns a snapshot of the current object value and automatically re-renders when the object changes.

        Type Parameters

        • T extends Unknown

        Parameters

        • obj: T

          The Echo object to subscribe to (objects only, not relations)

        Returns [Snapshot<T>, ObjectUpdateCallback<T>]

        The current object snapshot and update callback

      • <T extends Unknown>(
            obj: undefined | T,
        ): [undefined | Snapshot<T>, ObjectUpdateCallback<T>]

      • Hook to subscribe to an entire Echo object that may be undefined. Returns a snapshot (undefined if the object is undefined).

        Type Parameters

        • T extends Unknown

        Parameters

        • obj: undefined | T

          The Echo object to subscribe to (can be undefined, objects only)

        Returns [undefined | Snapshot<T>, ObjectUpdateCallback<T>]

        The current object snapshot (or undefined) and update callback

      • <T extends Unknown>(
            objOrRef: T | Ref<T>,
        ): [undefined | Snapshot<T>, ObjectUpdateCallback<T>]

      • Hook to subscribe to an Echo object or Ref. Handles both cases - if passed a Ref, dereferences it and subscribes to the target. Returns a snapshot (undefined if ref hasn't loaded).

        Type Parameters

        • T extends Unknown

        Parameters

        • objOrRef: T | Ref<T>

          The Echo object or Ref to subscribe to

        Returns [undefined | Snapshot<T>, ObjectUpdateCallback<T>]

        The current object snapshot (or undefined) and update callback

      • <T extends Unknown, K extends string | number | symbol>(
            obj: T,
            property: K,
        ): [T[K], ObjectPropUpdateCallback<T[K]>]

      • Hook to subscribe to a specific property of an Echo object. Returns the current property value and automatically re-renders when the property changes.

        Type Parameters

        • T extends Unknown
        • K extends string | number | symbol

        Parameters

        • obj: T

          The Echo object to subscribe to (objects only, not relations)

        • property: K

          Property key to subscribe to

        Returns [T[K], ObjectPropUpdateCallback<T[K]>]

        The current property value and update callback

      • <T extends Unknown, K extends string | number | symbol>(
            obj: undefined | T,
            property: K,
        ): [undefined | T[K], ObjectPropUpdateCallback<T[K]>]

      • Hook to subscribe to a specific property of an Echo object that may be undefined. Returns undefined if the object is undefined.

        Type Parameters

        • T extends Unknown
        • K extends string | number | symbol

        Parameters

        • obj: undefined | T

          The Echo object to subscribe to (can be undefined, objects only)

        • property: K

          Property key to subscribe to

        Returns [undefined | T[K], ObjectPropUpdateCallback<T[K]>]

        The current property value (or undefined) and update callback

      • <T, K extends string | number | symbol>(
            ref: Ref<T>,
            property: K,
        ): [undefined | T[K], ObjectPropUpdateCallback<T[K]>]

      • Hook to subscribe to a specific property of a Ref's target object. Automatically dereferences the ref and handles async loading. Returns undefined if the ref hasn't loaded yet.

        Type Parameters

        • T
        • K extends string | number | symbol

        Parameters

        • ref: Ref<T>

          The Ref to dereference and subscribe to

        • property: K

          Property key to subscribe to

        Returns [undefined | T[K], ObjectPropUpdateCallback<T[K]>]

        The current property value (or undefined if not loaded) and update callback

      • <T, K extends string | number | symbol>(
            ref: undefined | Ref<T>,
            property: K,
        ): [undefined | T[K], ObjectPropUpdateCallback<T[K]>]

      • Hook to subscribe to a specific property of a Ref's target object that may be undefined. Returns undefined if the ref is undefined or hasn't loaded yet.

        Type Parameters

        • T
        • K extends string | number | symbol

        Parameters

        • ref: undefined | Ref<T>

          The Ref to dereference and subscribe to (can be undefined)

        • property: K

          Property key to subscribe to

        Returns [undefined | T[K], ObjectPropUpdateCallback<T[K]>]

        The current property value (or undefined) and update callback

    Settings

    Member Visibility