Interface ResourceHandle<S>

The typed view of one registered entity, for internal callers — reads and writes go through the SAME pipeline as the transport, so there is no second dispatch path to drift.

interface ResourceHandle<S extends object> {
    path: string;
    create(id: ResourceId, delta: WireDelta): Promise<ResourceCreateResult>;
    patch(
        id: ResourceId,
        delta: WireDelta,
        source?: WriteSource,
    ): Promise<ResourcePatchResult<S>>;
    read(id: ResourceId): ResourceReadResult<S>;
    remove(id: ResourceId): Promise<ResourceRemoveResult>;
    reproject(id: ResourceId): ResourcePatchResult<S>;
}

Type Parameters

S extends object

Index

Properties

Methods

create patch read remove reproject

Properties

`Readonly`path

path: string

Methods

create

create(id: ResourceId, delta: WireDelta): Promise<ResourceCreateResult>
The POST door — likewise; the minted id comes back so a verb can ack with it.
Parameters
- id: ResourceId
- delta: WireDelta
Returns Promise<ResourceCreateResult>

patch

patch(
    id: ResourceId,
    delta: WireDelta,
    source?: WriteSource,
): Promise<ResourcePatchResult<S>>
Parameters
- id: ResourceId
- delta: WireDelta
- Optionalsource: WriteSource
Returns Promise<ResourcePatchResult<S>>

read

read(id: ResourceId): ResourceReadResult<S>
Parameters
- id: ResourceId
Returns ResourceReadResult<S>

remove

remove(id: ResourceId): Promise<ResourceRemoveResult>
The DELETE door — the same pipeline the transport reaches, for a translator to reuse.
Parameters
- id: ResourceId
Returns Promise<ResourceRemoveResult>

reproject

reproject(id: ResourceId): ResourcePatchResult<S>
Parameters
- id: ResourceId
Returns ResourcePatchResult<S>