@envoy/envoy-integrations-sdk / EnvoyPluginStorage
A key-value storage that can be scoped to a specific install, or to the plugin itself.
• new EnvoyPluginStorage(pluginAPI, installId?)
| Name | Type |
|---|---|
pluginAPI |
EnvoyPluginAPI |
installId? |
string |
• Readonly api: EnvoyPluginAPI
• Readonly installId: undefined | string
▸ get<Value>(key): Promise<null | EnvoyStorageItem<Value>>
Gets a single EnvoyStorageItem from storage.
Wrapper for single pipeline get.
| Name | Type |
|---|---|
Value |
Value = unknown |
| Name | Type |
|---|---|
key |
string |
Promise<null | EnvoyStorageItem<Value>>
▸ pipeline(): default
Creates a new pipeline instance.
default
▸ set<Value>(key, value): Promise<EnvoyStorageItem<Value>>
Sets a single EnvoyStorageItem from storage.
Wrapper for single pipeline set.
| Name | Type |
|---|---|
Value |
Value = unknown |
| Name | Type |
|---|---|
key |
string |
value |
Value |
Promise<EnvoyStorageItem<Value>>
▸ setUnique(key, options?): Promise<null | EnvoyStorageItem<string>>
Sets a single unique string EnvoyStorageItem from storage.
Wrapper for single pipeline setUnique.
| Name | Type |
|---|---|
key |
string |
options |
EnvoyStorageSetUniqueOptions |
Promise<null | EnvoyStorageItem<string>>
▸ setUniqueNum(key, options?): Promise<null | EnvoyStorageItem<number>>
Sets a single unique number EnvoyStorageItem from storage.
Wrapper for single pipeline setUnique.
| Name | Type |
|---|---|
key |
string |
options |
EnvoyStorageSetUniqueNumOptions |
Promise<null | EnvoyStorageItem<number>>
▸ unset(key): Promise<null | EnvoyStorageItem<unknown>>
Unsets an EnvoyStorageItem from storage. Returns null if the item did not previously exist.
Wrapper for single pipeline unset.
| Name | Type |
|---|---|
key |
string |
Promise<null | EnvoyStorageItem<unknown>>