Class JsonResourceStorage<T>

A KeyValueStorage for JSON-like objects using a ResourceStore as backend.

Creates a base URL by joining the input base URL with the container string. The storage assumes it has ownership over all entries in the target container so no other classes should access resources there to prevent issues.

Assumes the input keys can be safely used to generate identifiers, which will be appended to the stored base URL.

All non-404 errors will be re-thrown.

Type Parameters

Hierarchy

JsonResourceStorage

Implements

KeyValueStorage<string, T>

Index

Constructors

constructor

new JsonResourceStorage<T>(source: ResourceStore, baseUrl: string, container: string): JsonResourceStorage<T>
Type Parameters
- T
Parameters
- source: ResourceStore
- baseUrl: string
- container: string
Returns JsonResourceStorage<T>
- Defined in src/storage/keyvalue/JsonResourceStorage.ts:33

Properties

`Private` `Readonly` container

container: string

`Private` `Readonly` source

source: ResourceStore

Methods

`Private` applyHash

applyHash(key: string): string
Parameters
- key: string
Returns string
- Defined in src/storage/keyvalue/JsonResourceStorage.ts:146

delete

delete(key: string): Promise<boolean>
Deletes the value stored for the given key.

Returns
If there was a value to delete.
Parameters
- key: string
  
  Key to delete.
Returns Promise<boolean>
Implementation of KeyValueStorage.delete
- Defined in src/storage/keyvalue/JsonResourceStorage.ts:62

entries

entries(): AsyncIterableIterator<[string, T]>
An iterable of entries in the storage.

Returns AsyncIterableIterator<[string, T]>
Implementation of KeyValueStorage.entries
- Defined in src/storage/keyvalue/JsonResourceStorage.ts:75

get

get(key: string): Promise<undefined | T>
Returns the value stored for the given identifier. undefined if no value is stored.
Parameters
- key: string
Returns Promise<undefined | T>
Implementation of KeyValueStorage.get
- Defined in src/storage/keyvalue/JsonResourceStorage.ts:38

`Private` getResourceEntries

getResourceEntries(identifier: ResourceIdentifier): AsyncIterableIterator<[string, T]>
Recursively iterates through the container to find all documents.
Parameters
- identifier: ResourceIdentifier
Returns AsyncIterableIterator<[string, T]>
- Defined in src/storage/keyvalue/JsonResourceStorage.ts:82

has

has(key: string): Promise<boolean>
Checks if there is a value stored for the given key.
Parameters
- key: string
Returns Promise<boolean>
Implementation of KeyValueStorage.has
- Defined in src/storage/keyvalue/JsonResourceStorage.ts:50

`Private` identifierToKey

identifierToKey(identifier: ResourceIdentifier): string
Converts an internal identifier to an external key.
Parameters
- identifier: ResourceIdentifier
Returns string
- Defined in src/storage/keyvalue/JsonResourceStorage.ts:138

`Private` keyToIdentifier

keyToIdentifier(key: string): ResourceIdentifier
Converts a key into an identifier for internal storage.
Parameters
- key: string
Returns ResourceIdentifier
- Defined in src/storage/keyvalue/JsonResourceStorage.ts:122

`Private` safelyGetResource

safelyGetResource(identifier: ResourceIdentifier): Promise<undefined | Representation>
Returns the representation for the given identifier. Returns undefined if a 404 error is thrown. Re-throws the error in all other cases.
Parameters
- identifier: ResourceIdentifier
Returns Promise<undefined | Representation>
- Defined in src/storage/keyvalue/JsonResourceStorage.ts:104

set

set(key: string, value: unknown): Promise<JsonResourceStorage<T>>
Sets the value for the given key.

Returns
The storage.
Parameters
- key: string
  
  Key to set/update.
- value: unknown
  
  Value to store.
Returns Promise<JsonResourceStorage<T>>
Implementation of KeyValueStorage.set
- Defined in src/storage/keyvalue/JsonResourceStorage.ts:55

Class JsonResourceStorage<T>

Type Parameters

T

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T

Parameters

source: ResourceStore

baseUrl: string

container: string

Returns JsonResourceStorage<T>

Properties

Private Readonly container

Private Readonly source

Methods

Private applyHash

Parameters

key: string

Returns string

delete

Returns

Parameters

key: string

Returns Promise<boolean>

entries

Returns AsyncIterableIterator<[string, T]>

get

Parameters

key: string

Returns Promise<undefined | T>

Private getResourceEntries

Parameters

identifier: ResourceIdentifier

Returns AsyncIterableIterator<[string, T]>

has

Parameters

key: string

Returns Promise<boolean>

Private identifierToKey

Parameters

identifier: ResourceIdentifier

Returns string

Private keyToIdentifier

Parameters

key: string

Returns ResourceIdentifier

Private safelyGetResource

Parameters

identifier: ResourceIdentifier

Returns Promise<undefined | Representation>

set

Returns

Parameters

key: string

value: unknown

Returns Promise<JsonResourceStorage<T>>

Settings

Member Visibility

Theme

`Private` `Readonly` container

`Private` `Readonly` source

`Private` applyHash

`Private` getResourceEntries

`Private` identifierToKey

`Private` keyToIdentifier

`Private` safelyGetResource