@dxos/client
    Preparing search index...

    Interface IDocHandle<T>

    interface IDocHandle<T = any> {
        addListener(event: "change", listener: () => void): void;
        change(callback: ChangeFn<T>, options?: ChangeOptions<T>): void;
        changeAt(
            heads: Heads,
            callback: ChangeFn<T>,
            options?: ChangeOptions<T>,
        ): undefined | Heads;
        doc(): undefined | Doc<T>;
        removeListener(event: "change", listener: () => void): void;
    }

    Type Parameters

    • T = any
    Index

    Methods

    • Parameters

      • event: "change"
      • listener: () => void

      Returns void

    • Parameters

      • callback: ChangeFn<T>
      • Optionaloptions: ChangeOptions<T>

      Returns void

    • Parameters

      • heads: Heads
      • callback: ChangeFn<T>
      • Optionaloptions: ChangeOptions<T>

      Returns undefined | Heads

    • Returns undefined | Doc<T>

    • Parameters

      • event: "change"
      • listener: () => void

      Returns void