@mxraven/admin - v2.1.0
    Preparing search index...

    Class Entity<D>Abstract

    Base for hydrated resource entities. An entity wraps the wire record D with the client and path needed to act on the resource, plus local delete state.

    Reads return a snapshot; call reload() (where a subclass supports it) for fresh state. Entity.isDeleted is local bookkeeping for deletes performed through this instance — it cannot observe deletes made elsewhere.

    Type Parameters

    • D

      The wire record backing this entity.

    Hierarchy (View Summary)

    Index
    client: AdminClient

    The client used to issue requests for this entity.

    path: string

    The client-relative path of this resource.

    • get data(): D

      The raw wire record backing this entity.

      Returns D

    • get isDeleted(): boolean

      Whether this entity has been deleted through this instance.

      Local state only; not authoritative server state.

      Returns boolean

    • Deletes this resource.

      Idempotent per instance: once this instance has deleted the resource, further calls are a local no-op.

      Returns Promise<boolean>

      true once the resource has been deleted through this instance.

      ApiException When the control plane returns a non-success status.