Interface Blockstore<HasOptionsExtension, PutOptionsExtension, PutManyOptionsExtension, GetOptionsExtension, GetManyOptionsExtension, GetAllOptionsExtension, DeleteOptionsExtension, DeleteManyOptionsExtension>

interface Blockstore<
    HasOptionsExtension = {},
    PutOptionsExtension = {},
    PutManyOptionsExtension = {},
    GetOptionsExtension = {},
    GetManyOptionsExtension = {},
    GetAllOptionsExtension = {},
    DeleteOptionsExtension = {},
    DeleteManyOptionsExtension = {},
> {
    delete(
        key: CID,
        options?: AbortOptions & DeleteOptionsExtension,
    ): void | Promise<void>;
    deleteMany(
        source:
            | Iterable<CID<unknown, number, number, Version>, any, any>
            | AsyncIterable<CID<unknown, number, number, Version>, any, any>,
        options?: AbortOptions & DeleteManyOptionsExtension,
    ):
        | Generator<CID<unknown, number, number, Version>, any, any>
        | AsyncGenerator<CID<unknown, number, number, Version>, any, any>;
    get(
        key: CID,
        options?: AbortOptions & GetOptionsExtension,
    ):
        | Generator<Uint8Array<ArrayBufferLike>, any, any>
        | AsyncGenerator<Uint8Array<ArrayBufferLike>, any, any>;
    getAll(
        options?: AbortOptions & GetAllOptionsExtension,
    ): Generator<Pair, any, any> | AsyncGenerator<Pair, any, any>;
    getMany(
        source:
            | Iterable<CID<unknown, number, number, Version>, any, any>
            | AsyncIterable<CID<unknown, number, number, Version>, any, any>,
        options?: AbortOptions & GetManyOptionsExtension,
    ): Generator<Pair, any, any> | AsyncGenerator<Pair, any, any>;
    has(
        key: CID,
        options?: AbortOptions & HasOptionsExtension,
    ): boolean | Promise<boolean>;
    put(
        key: CID,
        val:
            | Uint8Array<ArrayBufferLike>
            | Iterable<Uint8Array<ArrayBufferLike>, any, any>
            | AsyncIterable<Uint8Array<ArrayBufferLike>, any, any>,
        options?: AbortOptions & PutOptionsExtension,
    ):
        | CID<unknown, number, number, Version>
        | Promise<CID<unknown, number, number, Version>>;
    putMany(
        source:
            | Iterable<InputPair, any, any>
            | AsyncIterable<InputPair, any, any>,
        options?: AbortOptions & PutManyOptionsExtension,
    ):
        | Generator<CID<unknown, number, number, Version>, any, any>
        | AsyncGenerator<CID<unknown, number, number, Version>, any, any>;
}

Type Parameters

HasOptionsExtension = {}
PutOptionsExtension = {}
PutManyOptionsExtension = {}
GetOptionsExtension = {}
GetManyOptionsExtension = {}
GetAllOptionsExtension = {}
DeleteOptionsExtension = {}
DeleteManyOptionsExtension = {}

Hierarchy (View Summary)

Store<
    CID,
    Uint8Array
    | Iterable<Uint8Array>
    | AsyncIterable<Uint8Array>,
    Generator<Uint8Array> | AsyncGenerator<Uint8Array>,
    InputPair,
    Pair,
    HasOptionsExtension,
    PutOptionsExtension,
    PutManyOptionsExtension,
    GetOptionsExtension,
    GetManyOptionsExtension,
    DeleteOptionsExtension,
    DeleteManyOptionsExtension,
>
- Blockstore

Implemented by

Index

Methods

delete deleteMany get getAll getMany has put putMany

Methods

delete

delete(
key: CID,
options?: AbortOptions & DeleteOptionsExtension,
): void | Promise<void>
Remove the record for the passed key
Parameters
- key: CID
- Optionaloptions: AbortOptions & DeleteOptionsExtension
Returns void | Promise<void>
Example
```
await store.delete(new Key('awesome'))
console.log('deleted awesome content :(')
```
Inherited from Store.delete
- Defined in interface-store/dist/src/index.d.ts:79

deleteMany

deleteMany(
    source:
        | Iterable<CID<unknown, number, number, Version>, any, any>
        | AsyncIterable<CID<unknown, number, number, Version>, any, any>,
    options?: AbortOptions & DeleteManyOptionsExtension,
):
    | Generator<CID<unknown, number, number, Version>, any, any>
    | AsyncGenerator<CID<unknown, number, number, Version>, any, any>
Remove values for the passed keys
Parameters
- source:
  | Iterable<CID<unknown, number, number, Version>, any, any>
  | AsyncIterable<CID<unknown, number, number, Version>, any, any>
- Optionaloptions: AbortOptions & DeleteManyOptionsExtension
Returns
| Generator<CID<unknown, number, number, Version>, any, any>
| AsyncGenerator<CID<unknown, number, number, Version>, any, any>
Example
```
const source = [new Key('awesome')]

for await (const key of store.deleteMany(source)) {
  console.log(`deleted content with key ${key}`)
}
```
Inherited from Store.deleteMany
- Defined in interface-store/dist/src/index.d.ts:93

get

get(
    key: CID,
    options?: AbortOptions & GetOptionsExtension,
):
    | Generator<Uint8Array<ArrayBufferLike>, any, any>
    | AsyncGenerator<Uint8Array<ArrayBufferLike>, any, any>
Retrieve the value stored under the given key
Parameters
- key: CID
- Optionaloptions: AbortOptions & GetOptionsExtension
Returns
| Generator<Uint8Array<ArrayBufferLike>, any, any>
| AsyncGenerator<Uint8Array<ArrayBufferLike>, any, any>
Example
```
const value = await store.get(new Key('awesome'))
console.log('got content: %s', value.toString('utf8'))
// => got content: datastore
```
Inherited from Store.get
- Defined in interface-store/dist/src/index.d.ts:56

getAll

getAll(
options?: AbortOptions & GetAllOptionsExtension,
): Generator<Pair, any, any> | AsyncGenerator<Pair, any, any>
Retrieve all cid/block pairs from the blockstore as an unordered iterable
Parameters
- Optionaloptions: AbortOptions & GetAllOptionsExtension
Returns Generator<Pair, any, any> | AsyncGenerator<Pair, any, any>
Example
```
for await (const { multihash, bytes } of store.getAll()) {
  console.log('got:', multihash, bytes)
  // => got MultihashDigest('Qmfoo') [Uint8Array[...]...]
}
```
- Defined in interface-blockstore/src/index.ts:49

getMany

getMany(
    source:
        | Iterable<CID<unknown, number, number, Version>, any, any>
        | AsyncIterable<CID<unknown, number, number, Version>, any, any>,
    options?: AbortOptions & GetManyOptionsExtension,
): Generator<Pair, any, any> | AsyncGenerator<Pair, any, any>
Retrieve values for the passed keys
Parameters
- source:
  | Iterable<CID<unknown, number, number, Version>, any, any>
  | AsyncIterable<CID<unknown, number, number, Version>, any, any>
- Optionaloptions: AbortOptions & GetManyOptionsExtension
Returns Generator<Pair, any, any> | AsyncGenerator<Pair, 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"
}
```
Inherited from Store.getMany
- Defined in interface-store/dist/src/index.d.ts:68

has

has(
key: CID,
options?: AbortOptions & HasOptionsExtension,
): boolean | Promise<boolean>
Check for the existence of a value for the passed key
Parameters
- key: CID
- 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')
}
```
Inherited from Store.has
- Defined in interface-store/dist/src/index.d.ts:22

put

put(
    key: CID,
    val:
        | Uint8Array<ArrayBufferLike>
        | Iterable<Uint8Array<ArrayBufferLike>, any, any>
        | AsyncIterable<Uint8Array<ArrayBufferLike>, any, any>,
    options?: AbortOptions & PutOptionsExtension,
):
    | CID<unknown, number, number, Version>
    | Promise<CID<unknown, number, number, Version>>
Store the passed value under the passed key
Parameters
- key: CID
- val:
      | Uint8Array<ArrayBufferLike>
      | Iterable<Uint8Array<ArrayBufferLike>, any, any>
      | AsyncIterable<Uint8Array<ArrayBufferLike>, any, any>
- Optionaloptions: AbortOptions & PutOptionsExtension
Returns
| CID<unknown, number, number, Version>
| Promise<CID<unknown, number, number, Version>>
Example
```
await store.put([{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }])
```
Inherited from Store.put
- Defined in interface-store/dist/src/index.d.ts:32

putMany

putMany(
    source:
        | Iterable<InputPair, any, any>
        | AsyncIterable<InputPair, any, any>,
    options?: AbortOptions & PutManyOptionsExtension,
):
    | Generator<CID<unknown, number, number, Version>, any, any>
    | AsyncGenerator<CID<unknown, number, number, Version>, any, any>
Store the given key/value pairs
Parameters
- source: Iterable<InputPair, any, any> | AsyncIterable<InputPair, any, any>
- Optionaloptions: AbortOptions & PutManyOptionsExtension
Returns
| Generator<CID<unknown, number, number, Version>, any, any>
| AsyncGenerator<CID<unknown, number, number, Version>, 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}`)
}
```
Inherited from Store.putMany
- Defined in interface-store/dist/src/index.d.ts:45

Interface Blockstore<HasOptionsExtension, PutOptionsExtension, PutManyOptionsExtension, GetOptionsExtension, GetManyOptionsExtension, GetAllOptionsExtension, DeleteOptionsExtension, DeleteManyOptionsExtension>

Type Parameters

Hierarchy (View Summary)

Implemented by

Index

Methods

Methods

delete

Parameters

Returns void | Promise<void>

Example

deleteMany

Parameters

Returns | Generator<CID<unknown, number, number, Version>, any, any> | AsyncGenerator<CID<unknown, number, number, Version>, any, any>

Example

get

Parameters

Returns | Generator<Uint8Array<ArrayBufferLike>, any, any> | AsyncGenerator<Uint8Array<ArrayBufferLike>, any, any>

Example

getAll

Parameters

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

Example

getMany

Parameters

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

Example

has

Parameters

Returns boolean | Promise<boolean>

Example

put

Parameters

Returns | CID<unknown, number, number, Version> | Promise<CID<unknown, number, number, Version>>

Example

putMany

Parameters

Returns | Generator<CID<unknown, number, number, Version>, any, any> | AsyncGenerator<CID<unknown, number, number, Version>, any, any>

Example

Settings

On This Page

Returns
| Generator<CID<unknown, number, number, Version>, any, any>
| AsyncGenerator<CID<unknown, number, number, Version>, any, any>

Returns
| Generator<Uint8Array<ArrayBufferLike>, any, any>
| AsyncGenerator<Uint8Array<ArrayBufferLike>, any, any>

Returns
| CID<unknown, number, number, Version>
| Promise<CID<unknown, number, number, Version>>

Returns
| Generator<CID<unknown, number, number, Version>, any, any>
| AsyncGenerator<CID<unknown, number, number, Version>, any, any>