@dxos/client
    Preparing search index...

    Variable changeConst

    change: <T extends Entity.Unknown>(
        entity: T,
        callback: internal.ChangeCallback<T>,
    ) => void

    Perform mutations on an entity (object or relation) within a change context.

    Entities are read-only by default. Mutations are batched and notifications fire when the callback completes. Direct mutations outside of Entity.change will throw at runtime.

    Type declaration

      • <T extends Entity.Unknown>(
            entity: T,
            callback: internal.ChangeCallback<T>,
        ): void

      • Type Parameters

        Parameters

        • entity: T

          The echo entity (object or relation) to mutate.

        • callback: internal.ChangeCallback<T>

          Receives a mutable view of the entity. All mutations must occur here.

        Returns void

    // Mutate within Entity.change
    Entity.change(entity, (obj) => {
      obj.name = 'Updated';
      obj.count = 42;
    });

    // Direct mutation throws
    entity.name = 'Bob'; // Error: Cannot modify outside Entity.change()

    Note: For type-specific operations, prefer Obj.change or Relation.change.

    Settings

    Member Visibility