@dxos/client
    Preparing search index...

    Interface Database

    ECHO Database interface.

    interface Database {
        query: QueryFn;
        get spaceId(): SpaceId;
        add<T extends Unknown = Unknown>(obj: T, opts?: AddOptions): T;
        makeRef<T extends Unknown = Unknown>(dxn: DXN): Ref<T>;
        remove(obj: Unknown): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    Accessors

    Methods

    Properties

    query: QueryFn

    Query objects.

    Accessors

    • get spaceId(): SpaceId

      Returns SpaceId

    Methods

    • Creates a reference to an existing object in the database.

      NOTE: The reference may be dangling if the object is not present in the database. NOTE: Difference from Ref.fromDXN Ref.fromDXN(dxn) returns an unhydrated reference. The .load and .target APIs will not work. db.makeRef(dxn) is preferable in cases with access to the database.

      Type Parameters

      Parameters

      • dxn: DXN

      Returns Ref<T>

    • Removes object from the database.

      Parameters

      Returns void