Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ResourceStore

A ResourceStore represents a collection of resources. It has been designed such that each of its methods can be implemented in an atomic way: for each CRUD operation, only one dedicated method needs to be called. A fifth method enables the optimization of partial updates with PATCH. It is up to the implementer of the interface to (not) make an implementation atomic.

ResourceStores are also responsible for taking auxiliary resources into account should those be relevant to the store.

Hierarchy

  • ResourceStore

Index

Properties

Properties

addResource

addResource: (container: ResourceIdentifier, representation: Representation, conditions?: Conditions) => Promise<ResourceIdentifier>

Creates a new resource in the container.

param

Container in which to create a resource.

param

Representation of the new resource

param

Optional conditions under which to proceed.

returns

The identifier of the newly created resource.

Type declaration

deleteResource

deleteResource: (identifier: ResourceIdentifier, conditions?: Conditions) => Promise<ResourceIdentifier[]>

Deletes a resource.

param

Identifier of resource to delete.

param

Optional conditions under which to proceed.

returns

Identifiers of resources that were possibly modified.

Type declaration

getRepresentation

getRepresentation: (identifier: ResourceIdentifier, preferences: RepresentationPreferences, conditions?: Conditions) => Promise<Representation>

Retrieves a representation of a resource.

param

Identifier of the resource to read.

param

Preferences indicating desired representations.

param

Optional conditions under which to proceed.

returns

A representation corresponding to the identifier.

Type declaration

modifyResource

modifyResource: (identifier: ResourceIdentifier, patch: Patch, conditions?: Conditions) => Promise<ResourceIdentifier[]>

Sets or updates the representation of a resource, creating a new resource and intermediary containers as needed.

param

Identifier of resource to update.

param

Description of which parts to update.

param

Optional conditions under which to proceed.

returns

Identifiers of resources that were possibly modified.

Type declaration

resourceExists

resourceExists: (identifier: ResourceIdentifier, conditions?: Conditions) => Promise<boolean>

Check if a resource exists.

param

Identifier of resource to check.

returns

A promise resolving if the resource already exists

Type declaration

setRepresentation

setRepresentation: (identifier: ResourceIdentifier, representation: Representation, conditions?: Conditions) => Promise<ResourceIdentifier[]>

Sets or replaces the representation of a resource, creating a new resource and intermediary containers as needed.

param

Identifier of resource to update.

param

New representation of the resource.

param

Optional conditions under which to proceed.

returns

Identifiers of resources that were possibly modified.

Type declaration