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

    Function useSpaceProperties

    • Subscribe to a space's properties with reactive updates. Returns undefined if the space is undefined or not ready yet. Automatically waits for the space to be ready before returning properties.

      Parameters

      • spaceId: undefined | SpaceId

        The space ID to get properties from (can be undefined).

      Returns [
          | undefined
          | Snapshot<
              {
                  computeEnvironment?: "edge"
                  | "disabled"
                  | "local";
                  description?: string;
                  edgeReplication?: boolean;
                  hue?: string;
                  icon?: string;
                  iconHue?: string;
                  invocationTraceFeed?: Ref<
                      { kind?: string; name?: string; namespace?: "trace"
                      | "data" } & OfKind<Object> & Unknown,
                  >;
                  name?: string;
              } & OfKind<Object>,
          >,
          ObjectUpdateCallback<
              {
                  computeEnvironment?: "edge"
                  | "disabled"
                  | "local";
                  description?: string;
                  edgeReplication?: boolean;
                  hue?: string;
                  icon?: string;
                  iconHue?: string;
                  invocationTraceFeed?: Ref<
                      { kind?: string; name?: string; namespace?: "trace"
                      | "data" } & OfKind<Object> & Unknown,
                  >;
                  name?: string;
              } & OfKind<Object>,
          >,
      ]

      A tuple of [snapshot, updateCallback] or [undefined, no-op] if not ready.