Classes

AdobeState: Cloud State Management

Members

MAX_TTL : number: Max supported TTL, 365 days in seconds

Functions

init([config]) ⇒ Promise.<AdobeState>

Initializes and returns the key-value-store SDK.

To use the SDK you must either provide your OpenWhisk credentials in config.ow or your own

OpenWhisk credentials can also be read from environment variables __OW_NAMESPACE and __OW_API_KEY.

Typedefs

AdobeStateCredentials : object: AdobeStateCredentials
AdobeStatePutOptions : object: AdobeState put options
AdobeStateGetReturnValue : object: AdobeState get return object
OpenWhiskCredentials : object: An object holding the OpenWhisk credentials
AdobeStateLibError : object
AdobeStateLibErrors : object: Adobe State lib custom errors. e.sdkDetails provides additional context for each error (e.g. function parameter)

AdobeState

Cloud State Management

Kind: global abstract class

AdobeState
- .getRegionalEndpoint(endpoint, region) ⇒ string
- .get(key) ⇒ Promise.<AdobeStateGetReturnValue>
- .put(key, value, [options]) ⇒ Promise.<string>
- .delete(key) ⇒ Promise.<(string|null)>
- .deleteAll(options) ⇒ Promise.<{keys: number}>
- .any() ⇒ Promise.<boolean>
- .stats() ⇒ Promise.<{bytesKeys: number, bytesValues: number, keys: number}>
- .list(options) ⇒ AsyncGenerator.<{keys: Array.<string>}>

adobeState.getRegionalEndpoint(endpoint, region) ⇒ `string`

Gets the regional endpoint for an endpoint.

Kind: instance method of AdobeState
Returns: string - the endpoint, with the correct region

Param	Type	Description
endpoint	`string`	the endpoint to test
region	`string`	the region to set

adobeState.get(key) ⇒ `Promise.<AdobeStateGetReturnValue>`

Retrieves the state value for given key. If the key doesn't exist returns undefined.

Kind: instance method of AdobeState
Returns: Promise.<AdobeStateGetReturnValue> - get response holding value and additional info

Param	Type	Description
key	`string`	state key identifier

adobeState.put(key, value, [options]) ⇒ `Promise.<string>`

Creates or updates a state key-value pair

Kind: instance method of AdobeState
Returns: Promise.<string> - key

Param	Type	Description
key	`string`	state key identifier
value	`string`	state value
[options]	`AdobeStatePutOptions`	put options

adobeState.delete(key) ⇒ `Promise.<(string|null)>`

Deletes a state key-value pair

Kind: instance method of AdobeState
Returns: Promise.<(string|null)> - key of deleted state or null if state does not exist

Param	Type	Description
key	`string`	state key identifier

adobeState.deleteAll(options) ⇒ `Promise.<{keys: number}>`

Deletes multiple key-values. The match option is required as a safeguard. CAUTION: use { match: '*' } to delete all key-values.

Kind: instance method of AdobeState
Returns: Promise.<{keys: number}> - returns an object with the number of deleted keys.

Param	Type	Description
options	`object`	deleteAll options.
options.match	`string`	REQUIRED, a glob pattern to specify which keys to delete.

Example

await state.deleteAll({ match: 'abc*' })

adobeState.any() ⇒ `Promise.<boolean>`

There exists key-values in the region.

Kind: instance method of AdobeState
Returns: Promise.<boolean> - true if exists, false if not

adobeState.stats() ⇒ `Promise.<{bytesKeys: number, bytesValues: number, keys: number}>`

Get stats.

Kind: instance method of AdobeState
Returns: Promise.<{bytesKeys: number, bytesValues: number, keys: number}> - State container stats.

adobeState.list(options) ⇒ `AsyncGenerator.<{keys: Array.<string>}>`

List keys, returns an iterator. Every iteration returns a batch of approximately countHint keys.

Kind: instance method of AdobeState
Returns: AsyncGenerator.<{keys: Array.<string>}> - an async generator which yields a { keys } object at every iteration.

Param	Type	Description
options	`object`	list options
options.match	`string`	a glob pattern that supports '*' to filter keys.
options.countHint	`number`	an approximate number on how many items to return per iteration. Default: 100, min: 10, max: 1000.

Example

for await (const { keys } of state.list({ match: 'abc*' })) {
   console.log(keys)
 }

MAX_TTL : `number`

Max supported TTL, 365 days in seconds

Kind: global variable

init([config]) ⇒ `Promise.<AdobeState>`

Initializes and returns the key-value-store SDK.

To use the SDK you must either provide your OpenWhisk credentials in config.ow or your own

OpenWhisk credentials can also be read from environment variables __OW_NAMESPACE and __OW_API_KEY.

Kind: global function
Returns: Promise.<AdobeState> - An AdobeState instance

Param	Type	Description
[config]	`object`	used to init the sdk
[config.ow]	`OpenWhiskCredentials`	OpenWhiskCredentials. Set those if you want to use ootb credentials to access the state management service. OpenWhisk namespace and auth can also be passed through environment variables: `__OW_NAMESPACE` and `__OW_API_KEY`
[config.region]	`string`	optional region to use, accepted values: `amer` (default), `emea`