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

    Class Hypergraph

    Manages cross-space database interactions.

    Index

    Constructors

    Properties

    query: QueryFn

    Accessors

    • get schemaRegistry(): RuntimeSchemaRegistry

      Returns RuntimeSchemaRegistry

    Methods

    • Parameters

      Returns unknown

    • Register a database.

      Parameters

      • spaceId: SpaceId

        Space id.

      • database: EchoDatabaseImpl

        Database backend.

      • OptionalowningObject: unknown

        Database owner, usually a space.

      Returns void

    • Parameters

      • __namedParameters: RefResolverOptions

      Returns RefResolver

      Result of onLoad.

    • 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.

      Ref.fromDXN(dxn) returns an unhydrated reference. The .load and .target APIs will not work. graph.ref(dxn) is preferable in cases with access to the database.

      Type Parameters

      • T extends AnyProperties = any

      Parameters

      • dxn: DXN

      Returns Ref<T>

    • Parameters

      • provider: QuerySourceProvider

      Returns void

    • Does not remove the provider from active query contexts.

      Parameters

      • provider: QuerySourceProvider

      Returns void