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,
    ): Await<void>;
    deleteMany(
        source: AwaitIterable<CID<unknown, number, number, Version>>,
        options?: AbortOptions & DeleteManyOptionsExtension,
    ): AwaitIterable<CID<unknown, number, number, Version>>;
    get(
        key: CID,
        options?: AbortOptions & GetOptionsExtension,
    ): Await<Uint8Array<ArrayBufferLike>>;
    getAll(
        options?: AbortOptions & GetAllOptionsExtension,
    ): AwaitIterable<Pair>;
    getMany(
        source: AwaitIterable<CID<unknown, number, number, Version>>,
        options?: AbortOptions & GetManyOptionsExtension,
    ): AwaitIterable<Pair>;
    has(key: CID, options?: AbortOptions & HasOptionsExtension): Await<boolean>;
    put(
        key: CID,
        val: Uint8Array,
        options?: AbortOptions & PutOptionsExtension,
    ): Await<CID<unknown, number, number, Version>>;
    putMany(
        source: AwaitIterable<Pair>,
        options?: AbortOptions & PutManyOptionsExtension,
    ): AwaitIterable<CID<unknown, number, number, Version>>;
}

Type Parameters

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

Hierarchy (View Summary)

Store<
    CID,
    Uint8Array,
    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): Await<void>
Remove the record for the passed key
Parameters
- key: CID
- Optionaloptions: AbortOptions & DeleteOptionsExtension
Returns Await<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:92

deleteMany

deleteMany(
source: AwaitIterable<CID<unknown, number, number, Version>>,
options?: AbortOptions & DeleteManyOptionsExtension,
): AwaitIterable<CID<unknown, number, number, Version>>
Remove values for the passed keys
Parameters
- source: AwaitIterable<CID<unknown, number, number, Version>>
- Optionaloptions: AbortOptions & DeleteManyOptionsExtension
Returns AwaitIterable<CID<unknown, number, number, Version>>
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:106

get

get(
key: CID,
options?: AbortOptions & GetOptionsExtension,
): Await<Uint8Array<ArrayBufferLike>>
Retrieve the value stored under the given key
Parameters
- key: CID
- Optionaloptions: AbortOptions & GetOptionsExtension
Returns Await<Uint8Array<ArrayBufferLike>>
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:69

getAll

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

getMany

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

has

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

put

put(
    key: CID,
    val: Uint8Array,
    options?: AbortOptions & PutOptionsExtension,
): Await<CID<unknown, number, number, Version>>
Store the passed value under the passed key
Parameters
- key: CID
- val: Uint8Array
- Optionaloptions: AbortOptions & PutOptionsExtension
Returns Await<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:45

putMany

putMany(
source: AwaitIterable<Pair>,
options?: AbortOptions & PutManyOptionsExtension,
): AwaitIterable<CID<unknown, number, number, Version>>
Store the given key/value pairs
Parameters
- source: AwaitIterable<Pair>
- Optionaloptions: AbortOptions & PutManyOptionsExtension
Returns AwaitIterable<CID<unknown, number, number, Version>>
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:58

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

Type Parameters

Hierarchy (View Summary)

Implemented by

Index

Methods

Methods

delete

Parameters

Returns Await<void>

Example

deleteMany

Parameters

Returns AwaitIterable<CID<unknown, number, number, Version>>

Example

get

Parameters

Returns Await<Uint8Array<ArrayBufferLike>>

Example

getAll

Parameters

Returns AwaitIterable<Pair>

Example

getMany

Parameters

Returns AwaitIterable<Pair>

Example

has

Parameters

Returns Await<boolean>

Example

put

Parameters

Returns Await<CID<unknown, number, number, Version>>

Example

putMany

Parameters

Returns AwaitIterable<CID<unknown, number, number, Version>>

Example

Settings

On This Page