Interface Store<Key, Input, Output, InputPair, OutputPair, HasOptionsExtension, PutOptionsExtension, PutManyOptionsExtension, GetOptionsExtension, GetManyOptionsExtension, DeleteOptionsExtension, DeleteManyOptionsExtension>

interface Store<
    Key,
    Input,
    Output,
    InputPair,
    OutputPair,
    HasOptionsExtension = {},
    PutOptionsExtension = {},
    PutManyOptionsExtension = {},
    GetOptionsExtension = {},
    GetManyOptionsExtension = {},
    DeleteOptionsExtension = {},
    DeleteManyOptionsExtension = {},
> {
    delete(
        key: Key,
        options?: AbortOptions & DeleteOptionsExtension,
    ): void | Promise<void>;
    deleteMany(
        source: Iterable<Key, any, any> | AsyncIterable<Key, any, any>,
        options?: AbortOptions & DeleteManyOptionsExtension,
    ): Generator<Key, any, any> | AsyncGenerator<Key, any, any>;
    get(key: Key, options?: AbortOptions & GetOptionsExtension): Output;
    getMany(
        source: Iterable<Key, any, any> | AsyncIterable<Key, any, any>,
        options?: AbortOptions & GetManyOptionsExtension,
    ): Generator<OutputPair, any, any> | AsyncGenerator<OutputPair, any, any>;
    has(
        key: Key,
        options?: AbortOptions & HasOptionsExtension,
    ): boolean | Promise<boolean>;
    put(
        key: Key,
        val: Input,
        options?: AbortOptions & PutOptionsExtension,
    ): Key | Promise<Key>;
    putMany(
        source:
            | Iterable<InputPair, any, any>
            | AsyncIterable<InputPair, any, any>,
        options?: AbortOptions & PutManyOptionsExtension,
    ): Generator<Key, any, any> | AsyncGenerator<Key, any, any>;
}

Type Parameters

Key
Input
Output
InputPair
OutputPair
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,
): void | Promise<void>
Remove the record for the passed key
Parameters
- key: Key
- Optionaloptions: AbortOptions & DeleteOptionsExtension
Returns void | Promise<void>
Example
```
await store.delete(new Key('awesome'))
console.log('deleted awesome content :(')
```
- Defined in packages/interface-store/src/index.ts:96

deleteMany

deleteMany(
source: Iterable<Key, any, any> | AsyncIterable<Key, any, any>,
options?: AbortOptions & DeleteManyOptionsExtension,
): Generator<Key, any, any> | AsyncGenerator<Key, any, any>
Remove values for the passed keys
Parameters
- source: Iterable<Key, any, any> | AsyncIterable<Key, any, any>
- Optionaloptions: AbortOptions & DeleteManyOptionsExtension
Returns Generator<Key, any, any> | AsyncGenerator<Key, any, any>
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:111

get

get(key: Key, options?: AbortOptions & GetOptionsExtension): Output
Retrieve the value stored under the given key
Parameters
- key: Key
- Optionaloptions: AbortOptions & GetOptionsExtension
Returns Output
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:68

getMany

getMany(
source: Iterable<Key, any, any> | AsyncIterable<Key, any, any>,
options?: AbortOptions & GetManyOptionsExtension,
): Generator<OutputPair, any, any> | AsyncGenerator<OutputPair, any, any>
Retrieve values for the passed keys
Parameters
- source: Iterable<Key, any, any> | AsyncIterable<Key, any, any>
- Optionaloptions: AbortOptions & GetManyOptionsExtension
Returns Generator<OutputPair, any, any> | AsyncGenerator<OutputPair, any, any>
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:81

has

has(
key: Key,
options?: AbortOptions & HasOptionsExtension,
): boolean | Promise<boolean>
Check for the existence of a value for the passed key
Parameters
- key: Key
- Optionaloptions: AbortOptions & HasOptionsExtension
Returns boolean | Promise<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:28

put

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

putMany

putMany(
    source:
        | Iterable<InputPair, any, any>
        | AsyncIterable<InputPair, any, any>,
    options?: AbortOptions & PutManyOptionsExtension,
): Generator<Key, any, any> | AsyncGenerator<Key, any, any>
Store the given key/value pairs
Parameters
- source: Iterable<InputPair, any, any> | AsyncIterable<InputPair, any, any>
- Optionaloptions: AbortOptions & PutManyOptionsExtension
Returns Generator<Key, any, any> | AsyncGenerator<Key, any, any>
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:53

Interface Store<Key, Input, Output, InputPair, OutputPair, HasOptionsExtension, PutOptionsExtension, PutManyOptionsExtension, GetOptionsExtension, GetManyOptionsExtension, DeleteOptionsExtension, DeleteManyOptionsExtension>

Type Parameters

Hierarchy (View Summary)

Index

Methods

Methods

delete

Parameters

Returns void | Promise<void>

Example

deleteMany

Parameters

Returns Generator<Key, any, any> | AsyncGenerator<Key, any, any>

Example

get

Parameters

Returns Output

Example

getMany

Parameters

Returns Generator<OutputPair, any, any> | AsyncGenerator<OutputPair, any, any>

Example

has

Parameters

Returns boolean | Promise<boolean>

Example

put

Parameters

Returns Key | Promise<Key>

Example

putMany

Parameters

Returns Generator<Key, any, any> | AsyncGenerator<Key, any, any>

Example

Settings

On This Page