Interface DevtoolsHook

Type declaration

• • (
        entity: { "~@dxos/echo/Kind": Object; id: string },
    ): {
        annotations: {
            [key: string & Brand<"~@dxos/echo/AnnotationKey">]: unknown;
        };
        createdAt?: number;
        key?: string;
        keys: { id: string; source: string }[];
        tags: Ref<{ hue?: string; label: string } & OfKind<Object>>[];
        updatedAt?: number;
        version?: string;
    }

  • Get the metadata for an object. Returns mutable meta when passed a mutable object (inside Obj.update callback). Returns read-only meta when passed a regular object or snapshot.

    Parameters

    • entity: { "~@dxos/echo/Kind": Object; id: string }

    Returns {
        annotations: {
            [key: string & Brand<"~@dxos/echo/AnnotationKey">]: unknown;
        };
        createdAt?: number;
        key?: string;
        keys: { id: string; source: string }[];
        tags: Ref<{ hue?: string; label: string } & OfKind<Object>>[];
        updatedAt?: number;
        version?: string;
    }

    • annotations: { [key: string & Brand<"~@dxos/echo/AnnotationKey">]: unknown }

      Dictionary of annotations to this entity.

    • OptionalcreatedAt?: number

      Unix ms timestamp when this entity was created. Read-only; sourced from the system section of the automerge document — not stored in meta.

    • Optionalkey?: string

      Fully-qualified registry key for the object (FQN format, e.g. org.example.type.foo). Identifies the canonical registry entry the object instance was created from.

    • keys: { id: string; source: string }[]

    • tags: Ref<{ hue?: string; label: string } & OfKind<Object>>[]

      Tags applied to this entity, as references to Tag objects.

    • OptionalupdatedAt?: number

      Unix ms timestamp of the last automerge change on this entity's document. Read-only; derived from the automerge change graph — not stored in meta.

    • Optionalversion?: string

      Semantic version of the registry entry the object was created from. Must be a valid semver string (e.g. 1.2.3).

    Example

    // Read-only access outside change callback
    const meta = Obj.getMeta(person);  // ReadonlyMeta
    
    // Mutable access inside change callback
    Obj.update(person, (obj) => {
      const meta = Obj.getMeta(obj);     // EntityMeta (mutable)
      meta.tags.push(Ref.make(tag));     // tags are refs to Tag objects
    });
    Copy

  • (
        entity: Unknown | Snapshot<Unknown>,
    ): {
        annotations: {
            readonly [key: string & Brand<"~@dxos/echo/AnnotationKey">]: unknown;
        };
        createdAt?: number;
        key?: string;
        keys: readonly { id: string; source: string }[];
        tags: readonly {
            "[RefTypeId]": {
                _T: {
                    "~@dxos/echo/Kind": Object;
                    hue?: string;
                    id: string;
                    label: string;
                };
            };
            atom: {
                "[NodeInspectSymbol]": {};
                "~effect-atom/atom/Atom": "~effect-atom/atom/Atom";
                idleTTL?: number;
                keepAlive: boolean;
                label?: readonly [string, string];
                lazy: boolean;
                pipe: {};
                read: {};
                refresh?: {};
                toJSON: {};
                toString: {};
            };
            encode: {};
            isAvailable: boolean;
            load: {};
            noInline: {};
            onResolved: {};
            pipe: {};
            target: | undefined
            | { "~@dxos/echo/Kind": Object; hue?: string; id: string; label: string };
            tryLoad: {};
            uri: URI;
        }[];
        updatedAt?: number;
        version?: string;
    }

  • Get the metadata for an object. Returns mutable meta when passed a mutable object (inside Obj.update callback). Returns read-only meta when passed a regular object or snapshot.

    Parameters

    • entity: Unknown | Snapshot<Unknown>

    Returns {
        annotations: {
            readonly [key: string & Brand<"~@dxos/echo/AnnotationKey">]: unknown;
        };
        createdAt?: number;
        key?: string;
        keys: readonly { id: string; source: string }[];
        tags: readonly {
            "[RefTypeId]": {
                _T: {
                    "~@dxos/echo/Kind": Object;
                    hue?: string;
                    id: string;
                    label: string;
                };
            };
            atom: {
                "[NodeInspectSymbol]": {};
                "~effect-atom/atom/Atom": "~effect-atom/atom/Atom";
                idleTTL?: number;
                keepAlive: boolean;
                label?: readonly [string, string];
                lazy: boolean;
                pipe: {};
                read: {};
                refresh?: {};
                toJSON: {};
                toString: {};
            };
            encode: {};
            isAvailable: boolean;
            load: {};
            noInline: {};
            onResolved: {};
            pipe: {};
            target: | undefined
            | { "~@dxos/echo/Kind": Object; hue?: string; id: string; label: string };
            tryLoad: {};
            uri: URI;
        }[];
        updatedAt?: number;
        version?: string;
    }

    • Readonlyannotations: { readonly [key: string & Brand<"~@dxos/echo/AnnotationKey">]: unknown }

      Dictionary of annotations to this entity.

    • Optional ReadonlycreatedAt?: number

      Unix ms timestamp when this entity was created. Read-only; sourced from the system section of the automerge document — not stored in meta.

    • Optional Readonlykey?: string

      Fully-qualified registry key for the object (FQN format, e.g. org.example.type.foo). Identifies the canonical registry entry the object instance was created from.

    • Readonlykeys: readonly { id: string; source: string }[]

    • Readonlytags: readonly {
          "[RefTypeId]": {
              _T: {
                  "~@dxos/echo/Kind": Object;
                  hue?: string;
                  id: string;
                  label: string;
              };
          };
          atom: {
              "[NodeInspectSymbol]": {};
              "~effect-atom/atom/Atom": "~effect-atom/atom/Atom";
              idleTTL?: number;
              keepAlive: boolean;
              label?: readonly [string, string];
              lazy: boolean;
              pipe: {};
              read: {};
              refresh?: {};
              toJSON: {};
              toString: {};
          };
          encode: {};
          isAvailable: boolean;
          load: {};
          noInline: {};
          onResolved: {};
          pipe: {};
          target: | undefined
          | { "~@dxos/echo/Kind": Object; hue?: string; id: string; label: string };
          tryLoad: {};
          uri: URI;
      }[]

      Tags applied to this entity, as references to Tag objects.

    • Optional ReadonlyupdatedAt?: number

      Unix ms timestamp of the last automerge change on this entity's document. Read-only; derived from the automerge change graph — not stored in meta.

    • Optional Readonlyversion?: string

      Semantic version of the registry entry the object was created from. Must be a valid semver string (e.g. 1.2.3).

    Example

    // Read-only access outside change callback
    const meta = Obj.getMeta(person);  // ReadonlyMeta
    
    // Mutable access inside change callback
    Obj.update(person, (obj) => {
      const meta = Obj.getMeta(obj);     // EntityMeta (mutable)
      meta.tags.push(Ref.make(tag));     // tags are refs to Tag objects
    });
    Copy