Class LevelBlockstore

A blockstore backed by leveldb

Hierarchy (view full)

BaseBlockstore
- LevelBlockstore

Index

Constructors

constructor

new LevelBlockstore(path, init?): LevelBlockstore
Parameters
- path: string | Level<string, Uint8Array>
- init: LevelBlockstoreInit = {}
Returns LevelBlockstore
Overrides BaseBlockstore.constructor
- Defined in packages/blockstore-level/src/index.ts:45

Properties

`Private` `Readonly` base

base: MultibaseCodec<string>

db

db: Level<string, Uint8Array>

`Private` `Readonly` opts

opts: OpenOptions

Methods

`Private` #decode

#decode(key): CID<unknown, number, number, Version>
Parameters
- key: string
Returns CID<unknown, number, number, Version>
- Defined in packages/blockstore-level/src/index.ts:69

`Private` #encode

#encode(cid): string
Parameters
- cid: CID<unknown, number, number, Version>
Returns string
- Defined in packages/blockstore-level/src/index.ts:65

`Private` #query

#query(opts): AsyncIterable<{
key: string;
value: Uint8Array;
}>
Parameters
- opts: {
  prefix?: string;
  values: boolean;
  }
  - Optional prefix?: string
  - values: boolean
Returns AsyncIterable<{
key: string;
value: Uint8Array;
}>
- Defined in packages/blockstore-level/src/index.ts:136

close

close(): Promise<void>
Returns Promise<void>
- Defined in packages/blockstore-level/src/index.ts:126

delete

delete(key): Promise<void>
Remove the record for the passed key
Parameters
- key: CID<unknown, number, number, Version>
Returns Promise<void>
Example
```
await store.delete(new Key('awesome'))
console.log('deleted awesome content :(')
```
Overrides BaseBlockstore.delete
- Defined in packages/blockstore-level/src/index.ts:118

deleteMany

deleteMany(source, options?): AwaitIterable<CID<unknown, number, number, Version>>
Remove values for the passed keys
Parameters
- source: AwaitIterable<CID<unknown, number, number, Version>>
- Optional options: AbortOptions
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 BaseBlockstore.deleteMany
- Defined in packages/blockstore-core/dist/src/base.d.ts:11

get

get(key): Promise<Uint8Array>
Retrieve the value stored under the given key
Parameters
- key: CID<unknown, number, number, Version>
Returns Promise<Uint8Array>
Example
```
const value = await store.get(new Key('awesome'))
console.log('got content: %s', value.toString('utf8'))
// => got content: datastore
```
Overrides BaseBlockstore.get
- Defined in packages/blockstore-level/src/index.ts:91

getAll

getAll(options?): AwaitIterable<Pair>
Extending classes should override query or implement this method
Parameters
- Optional options: AbortOptions
Returns AwaitIterable<Pair>
Overrides BaseBlockstore.getAll
- Defined in packages/blockstore-level/src/index.ts:130

getMany

getMany(source, options?): AwaitIterable<Pair>
Retrieve values for the passed keys
Parameters
- source: AwaitIterable<CID<unknown, number, number, Version>>
- Optional options: AbortOptions
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 BaseBlockstore.getMany
- Defined in packages/blockstore-core/dist/src/base.d.ts:9

has

has(key): Promise<boolean>
Check for the existence of a value for the passed key
Parameters
- key: CID<unknown, number, number, Version>
Returns 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')
}
```
Overrides BaseBlockstore.has
- Defined in packages/blockstore-level/src/index.ts:105

open

open(): Promise<void>
Returns Promise<void>
- Defined in packages/blockstore-level/src/index.ts:73

put

put(key, value): Promise<CID<unknown, number, number, Version>>
Store the passed value under the passed key
Parameters
- key: CID<unknown, number, number, Version>
- value: Uint8Array
Returns Promise<CID<unknown, number, number, Version>>
Example
```
await store.put([{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }])
```
Overrides BaseBlockstore.put
- Defined in packages/blockstore-level/src/index.ts:81

putMany

putMany(source, options?): AwaitIterable<CID<unknown, number, number, Version>>
Store the given key/value pairs
Parameters
- source: AwaitIterable<Pair>
- Optional options: AbortOptions
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 BaseBlockstore.putMany
- Defined in packages/blockstore-core/dist/src/base.d.ts:7

Class LevelBlockstore

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LevelBlockstore

Properties

Private Readonly base

db

Private Readonly opts

Methods

Private #decode

Parameters

Returns CID<unknown, number, number, Version>

Private #encode

Parameters

Returns string

Private #query

Parameters

Optional prefix?: string

values: boolean

Returns AsyncIterable<{ key: string; value: Uint8Array; }>

close

Returns Promise<void>

delete

Parameters

Returns Promise<void>

Example

deleteMany

Parameters

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

Example

get

Parameters

Returns Promise<Uint8Array>

Example

getAll

Parameters

Returns AwaitIterable<Pair>

getMany

Parameters

Returns AwaitIterable<Pair>

Example

has

Parameters

Returns Promise<boolean>

Example

open

Returns Promise<void>

put

Parameters

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

Example

putMany

Parameters

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

Example

Settings

Member Visibility

Theme

On This Page

`Private` `Readonly` base

`Private` `Readonly` opts

`Private` #decode

`Private` #encode

`Private` #query

`Optional` prefix?: string

Returns AsyncIterable<{
key: string;
value: Uint8Array;
}>