Class PatchingStore<T>

ResourceStore using decorator pattern for the modifyResource function. If the original store supports the Patch, behaviour will be identical, otherwise the PatchHandler will be called instead.

Type parameters

T: ResourceStore = ResourceStore

Hierarchy

PassthroughStore<T>
- PatchingStore

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PatchingStore<T>(source: T, patchHandler: PatchHandler<ResourceStore>): PatchingStore<T>

Overrides PassthroughStore.constructor
- Defined in src/storage/PatchingStore.ts:17
Type parameters
- T: ResourceStore = ResourceStore
Parameters
- source: T
- patchHandler: PatchHandler<ResourceStore>
Returns PatchingStore<T>

Properties

Private Readonly patchHandler

patchHandler: PatchHandler<ResourceStore>

Protected Readonly source

source: T

Methods

addResource

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

Inherited from PassthroughStore.addResource
- Defined in src/storage/PassthroughStore.ts:29
Creates a new resource in the container.

Parameters
- container: ResourceIdentifier
- representation: Representation
- Optional conditions: Conditions
Returns Promise<ResourceIdentifier>

deleteResource

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

Inherited from PassthroughStore.deleteResource
- Defined in src/storage/PassthroughStore.ts:34
Deletes a resource.

Parameters
- identifier: ResourceIdentifier
- Optional conditions: Conditions
Returns Promise<ResourceIdentifier[]>

getRepresentation

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

Inherited from PassthroughStore.getRepresentation
- Defined in src/storage/PassthroughStore.ts:24
Retrieves a representation of a resource.

Parameters
- identifier: ResourceIdentifier
- preferences: RepresentationPreferences
- Optional conditions: Conditions
Returns Promise<Representation>

modifyResource

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

Overrides PassthroughStore.modifyResource
- Defined in src/storage/PatchingStore.ts:22
Sets or updates the representation of a resource, creating a new resource and intermediary containers as needed.

Parameters
- identifier: ResourceIdentifier
- patch: Patch
- Optional conditions: Conditions
Returns Promise<ResourceIdentifier[]>

resourceExists

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

Inherited from PassthroughStore.resourceExists
- Defined in src/storage/PassthroughStore.ts:20
Check if a resource exists.

Parameters
- identifier: ResourceIdentifier
- Optional conditions: Conditions
Returns Promise<boolean>

setRepresentation

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

Inherited from PassthroughStore.setRepresentation
- Defined in src/storage/PassthroughStore.ts:44
Sets or replaces the representation of a resource, creating a new resource and intermediary containers as needed.

Parameters
- identifier: ResourceIdentifier
- representation: Representation
- Optional conditions: Conditions
Returns Promise<ResourceIdentifier[]>