Interface Store<Key, Value, Pair, HasOptionsExtension, PutOptionsExtension, PutManyOptionsExtension, GetOptionsExtension, GetManyOptionsExtension, DeleteOptionsExtension, DeleteManyOptionsExtension>

interface Store<
    Key,
    Value,
    Pair,
    HasOptionsExtension = {},
    PutOptionsExtension = {},
    PutManyOptionsExtension = {},
    GetOptionsExtension = {},
    GetManyOptionsExtension = {},
    DeleteOptionsExtension = {},
    DeleteManyOptionsExtension = {},
> {
    delete(
        key: Key,
        options?: AbortOptions & DeleteOptionsExtension,
    ): Await<void>;
    deleteMany(
        source: AwaitIterable<Key>,
        options?: AbortOptions & DeleteManyOptionsExtension,
    ): AwaitIterable<Key>;
    get(key: Key, options?: AbortOptions & GetOptionsExtension): Await<Value>;
    getMany(
        source: AwaitIterable<Key>,
        options?: AbortOptions & GetManyOptionsExtension,
    ): AwaitIterable<Pair>;
    has(key: Key, options?: AbortOptions & HasOptionsExtension): Await<boolean>;
    put(
        key: Key,
        val: Value,
        options?: AbortOptions & PutOptionsExtension,
    ): Await<Key>;
    putMany(
        source: AwaitIterable<Pair>,
        options?: AbortOptions & PutManyOptionsExtension,
    ): AwaitIterable<Key>;
}

Type Parameters

Key
Value
Pair
HasOptionsExtension = {}
PutOptionsExtension = {}
PutManyOptionsExtension = {}
GetOptionsExtension = {}
GetManyOptionsExtension = {}
DeleteOptionsExtension = {}
DeleteManyOptionsExtension = {}

Hierarchy (View Summary)

Store
- Blockstore
- Datastore

Index

Methods

delete deleteMany get getMany has put putMany

Methods

delete

delete(key: Key, options?: AbortOptions & DeleteOptionsExtension): Await<void>
Remove the record for the passed key
Parameters
- key: Key
- Optionaloptions: AbortOptions & DeleteOptionsExtension
Returns Await<void>
Example
```
await store.delete(new Key('awesome'))
console.log('deleted awesome content :(')
```
- Defined in packages/interface-store/src/index.ts:110

deleteMany

deleteMany(
source: AwaitIterable<Key>,
options?: AbortOptions & DeleteManyOptionsExtension,
): AwaitIterable<Key>
Remove values for the passed keys
Parameters
- source: AwaitIterable<Key>
- Optionaloptions: AbortOptions & DeleteManyOptionsExtension
Returns AwaitIterable<Key>
Example
```
const source = [new Key('awesome')]

for await (const key of store.deleteMany(source)) {
  console.log(`deleted content with key ${key}`)
}
```
- Defined in packages/interface-store/src/index.ts:125

get

get(key: Key, options?: AbortOptions & GetOptionsExtension): Await<Value>
Retrieve the value stored under the given key
Parameters
- key: Key
- Optionaloptions: AbortOptions & GetOptionsExtension
Returns Await<Value>
Example
```
const value = await store.get(new Key('awesome'))
console.log('got content: %s', value.toString('utf8'))
// => got content: datastore
```
- Defined in packages/interface-store/src/index.ts:82

getMany

getMany(
source: AwaitIterable<Key>,
options?: AbortOptions & GetManyOptionsExtension,
): AwaitIterable<Pair>
Retrieve values for the passed keys
Parameters
- source: AwaitIterable<Key>
- Optionaloptions: AbortOptions & GetManyOptionsExtension
Returns AwaitIterable<Pair>
Example
```
for await (const { key, value } of store.getMany([new Key('awesome')])) {
  console.log(`got "${key}" = "${new TextDecoder('utf8').decode(value)}"`')
  // => got "/awesome" = "datastore"
}
```
- Defined in packages/interface-store/src/index.ts:95

has

has(key: Key, options?: AbortOptions & HasOptionsExtension): Await<boolean>
Check for the existence of a value for the passed key
Parameters
- key: Key
- Optionaloptions: AbortOptions & HasOptionsExtension
Returns Await<boolean>
Example
```
const exists = await store.has(new Key('awesome'))

if (exists) {
 console.log('it is there')
} else {
 console.log('it is not there')
}
```
- Defined in packages/interface-store/src/index.ts:42

put

put(
    key: Key,
    val: Value,
    options?: AbortOptions & PutOptionsExtension,
): Await<Key>
Store the passed value under the passed key
Parameters
- key: Key
- val: Value
- Optionaloptions: AbortOptions & PutOptionsExtension
Returns Await<Key>
Example
```
await store.put([{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }])
```
- Defined in packages/interface-store/src/index.ts:53

putMany

putMany(
source: AwaitIterable<Pair>,
options?: AbortOptions & PutManyOptionsExtension,
): AwaitIterable<Key>
Store the given key/value pairs
Parameters
- source: AwaitIterable<Pair>
- Optionaloptions: AbortOptions & PutManyOptionsExtension
Returns AwaitIterable<Key>
Example
```
const source = [{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }]

for await (const { key, value } of store.putMany(source)) {
  console.info(`put content for key ${key}`)
}
```
- Defined in packages/interface-store/src/index.ts:67

Interface Store<Key, Value, Pair, HasOptionsExtension, PutOptionsExtension, PutManyOptionsExtension, GetOptionsExtension, GetManyOptionsExtension, DeleteOptionsExtension, DeleteManyOptionsExtension>

Type Parameters

Hierarchy (View Summary)

Index

Methods

Methods

delete

Parameters

Returns Await<void>

Example

deleteMany

Parameters

Returns AwaitIterable<Key>

Example

get

Parameters

Returns Await<Value>

Example

getMany

Parameters

Returns AwaitIterable<Pair>

Example

has

Parameters

Returns Await<boolean>

Example

put

Parameters

Returns Await<Key>

Example

putMany

Parameters

Returns AwaitIterable<Key>

Example

Settings

On This Page