Interface EntityOptions<D>

Construction options for an Entity.

interface EntityOptions<D> {
    client: AdminClient;
    data: D;
    deleted?: boolean;
    path: string;
}

Type Parameters

D

Index

Properties

client data deleted? path

Properties

`Readonly`client

client: AdminClient

The client used to issue requests for this entity.

`Readonly`data

data: D

The raw wire record backing this entity.

`Optional` `Readonly`deleted

deleted?: boolean

Whether the entity is considered deleted.

`Readonly`path

path: string

The client-relative path of this resource.