Interface DevtoolsHook

Type declaration

• • (
        entity: { "~@dxos/echo/Kind": Object; id: string },
    ): { keys: { id: string; source: string }[]; tags?: string[] }

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

    Parameters

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

    Returns { keys: { id: string; source: string }[]; tags?: string[] }

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

    • Optionaltags?: string[]

      A set of tags. Tags are arbitrary application-defined strings. ECHO makes no assumptions about the tag structure.

    Example

    // Read-only access outside change callback
    const meta = Obj.getMeta(person);  // ReadonlyMeta
    
    // Mutable access inside change callback
    Obj.change(person, (p) => {
      const meta = Obj.getMeta(p);     // ObjectMeta (mutable)
      meta.tags ??= [];
      meta.tags.push('important');
    });
    Copy

  • (
        entity: Unknown | Snapshot<Unknown>,
    ): {
        keys: readonly { id: string; source: string }[];
        tags?: readonly string[];
    }

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

    Parameters

    • entity: Unknown | Snapshot<Unknown>

    Returns { keys: readonly { id: string; source: string }[]; tags?: readonly string[] }

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

    • Optional Readonlytags?: readonly string[]

      A set of tags. Tags are arbitrary application-defined strings. ECHO makes no assumptions about the tag structure.

    Example

    // Read-only access outside change callback
    const meta = Obj.getMeta(person);  // ReadonlyMeta
    
    // Mutable access inside change callback
    Obj.change(person, (p) => {
      const meta = Obj.getMeta(p);     // ObjectMeta (mutable)
      meta.tags ??= [];
      meta.tags.push('important');
    });
    Copy