KvStoreApi API

The kvStoreApi module of the @codebolt/plugin-sdk.

import plugin from '@codebolt/plugin-sdk';

Quick Reference

Method	Description
createInstance
deleteInstance
deleteNamespace
deleteValue
getInstance
getValue
listInstances
query
setValue
updateInstance

Methods

---

createInstance

plugin.kvStoreApi.createInstance(data: CreateKvStoreInstanceRequest): Promise<KvStoreInstance>

Parameter	Type	Required	Description
data	CreateKvStoreInstanceRequest	Yes

Returns: Promise<KvStoreInstance>

Full reference →

---

deleteInstance

plugin.kvStoreApi.deleteInstance(id: string): Promise<unknown>

Parameter	Type	Required	Description
id	string	Yes

Returns: Promise<unknown>

Full reference →

---

deleteNamespace

plugin.kvStoreApi.deleteNamespace(instanceId: string, namespace: string): Promise<unknown>

Parameter	Type	Required	Description
instanceId	string	Yes
namespace	string	Yes

Returns: Promise<unknown>

Full reference →

---

deleteValue

plugin.kvStoreApi.deleteValue(instanceId: string, namespace: string, key: string): Promise<unknown>

Parameter	Type	Required	Description
instanceId	string	Yes
namespace	string	Yes
key	string	Yes

Returns: Promise<unknown>

Full reference →

---

getInstance

plugin.kvStoreApi.getInstance(id: string): Promise<KvStoreInstance>

Parameter	Type	Required	Description
id	string	Yes

Returns: Promise<KvStoreInstance>

Full reference →

---

getValue

plugin.kvStoreApi.getValue(instanceId: string, namespace: string, key: string): Promise<KvValue>

Parameter	Type	Required	Description
instanceId	string	Yes
namespace	string	Yes
key	string	Yes

Returns: Promise<KvValue>

Full reference →

---

listInstances

plugin.kvStoreApi.listInstances(params?: Record<string, unknown>): Promise<KvStoreInstance[]>

Parameter	Type	Required	Description
params	Record<string, unknown>	No

Returns: Promise<KvStoreInstance[]>

Full reference →

---

query

plugin.kvStoreApi.query(data: KvQueryRequest): Promise<KvValue[]>

Parameter	Type	Required	Description
data	KvQueryRequest	Yes

Returns: Promise<KvValue[]>

Full reference →

---

setValue

plugin.kvStoreApi.setValue(data: SetKvValueRequest): Promise<KvValue>

Parameter	Type	Required	Description
data	SetKvValueRequest	Yes

Returns: Promise<KvValue>

Full reference →

---

updateInstance

plugin.kvStoreApi.updateInstance(id: string, data: UpdateKvStoreInstanceRequest): Promise<KvStoreInstance>

Parameter	Type	Required	Description
id	string	Yes
data	UpdateKvStoreInstanceRequest	Yes

Returns: Promise<KvStoreInstance>

Full reference →