Interface Datastore<HasOptionsExtension, PutOptionsExtension, PutManyOptionsExtension, GetOptionsExtension, GetManyOptionsExtension, DeleteOptionsExtension, DeleteManyOptionsExtension, QueryOptionsExtension, QueryKeysOptionsExtension, BatchOptionsExtension>

interface Datastore<
    HasOptionsExtension = {},
    PutOptionsExtension = {},
    PutManyOptionsExtension = {},
    GetOptionsExtension = {},
    GetManyOptionsExtension = {},
    DeleteOptionsExtension = {},
    DeleteManyOptionsExtension = {},
    QueryOptionsExtension = {},
    QueryKeysOptionsExtension = {},
    BatchOptionsExtension = {},
> {
    batch(): Batch<BatchOptionsExtension>;
    delete(
        key: Key,
        options?: AbortOptions & DeleteOptionsExtension,
    ): Await<void>;
    deleteMany(
        source: AwaitIterable<Key>,
        options?: AbortOptions & DeleteManyOptionsExtension,
    ): AwaitGenerator<Key>;
    get(key: Key, options?: AbortOptions & GetOptionsExtension): Await;
    getMany(
        source: AwaitIterable<Key>,
        options?: AbortOptions & GetManyOptionsExtension,
    ): AwaitGenerator<Pair>;
    has(key: Key, options?: AbortOptions & HasOptionsExtension): Await<boolean>;
    put(
        key: Key,
        val: Uint8Array,
        options?: AbortOptions & PutOptionsExtension,
    ): Await<Key>;
    putMany(
        source: AwaitIterable<Pair>,
        options?: AbortOptions & PutManyOptionsExtension,
    ): AwaitGenerator<Key>;
    query(
        query: Query,
        options?: AbortOptions & QueryOptionsExtension,
    ): AwaitGenerator<Pair>;
    queryKeys(
        query: KeyQuery,
        options?: AbortOptions & QueryKeysOptionsExtension,
    ): AwaitGenerator<Key>;
}

Type Parameters

HasOptionsExtension = {}
PutOptionsExtension = {}
PutManyOptionsExtension = {}
GetOptionsExtension = {}
GetManyOptionsExtension = {}
DeleteOptionsExtension = {}
DeleteManyOptionsExtension = {}
QueryOptionsExtension = {}
QueryKeysOptionsExtension = {}
BatchOptionsExtension = {}

Hierarchy (View Summary)

Store<
    Key,
    Uint8Array,
    Await<Uint8Array>,
    Pair,
    Pair,
    HasOptionsExtension,
    PutOptionsExtension,
    PutManyOptionsExtension,
    GetOptionsExtension,
    GetManyOptionsExtension,
    DeleteOptionsExtension,
    DeleteManyOptionsExtension,
>
- Datastore

Implemented by

BaseDatastore

Index

Methods

batch delete deleteMany get getMany has put putMany query queryKeys

Methods

batch

batch(): Batch<BatchOptionsExtension>
This will return an object with which you can chain multiple operations together, with them only being executed on calling commit.

Returns Batch<BatchOptionsExtension>
Example
```
const b = store.batch()

for (let i = 0; i < 100; i++) {
  b.put(new Key(`hello${i}`), new TextEncoder('utf8').encode(`hello world ${i}`))
}

await b.commit()
console.log('put 100 values')
```
- Defined in interface-datastore/src/index.ts:143

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 :(')
```
Inherited from Store.delete
- Defined in interface-store/dist/src/index.d.ts:96

deleteMany

deleteMany(
source: AwaitIterable<Key>,
options?: AbortOptions & DeleteManyOptionsExtension,
): AwaitGenerator<Key>
Remove values for the passed keys
Parameters
- source: AwaitIterable<Key>
- Optionaloptions: AbortOptions & DeleteManyOptionsExtension
Returns AwaitGenerator<Key>
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:110

get

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

getMany

getMany(
source: AwaitIterable<Key>,
options?: AbortOptions & GetManyOptionsExtension,
): AwaitGenerator<Pair>
Retrieve values for the passed keys
Parameters
- source: AwaitIterable<Key>
- Optionaloptions: AbortOptions & GetManyOptionsExtension
Returns AwaitGenerator<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:85

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')
}
```
Inherited from Store.has
- Defined in interface-store/dist/src/index.d.ts:39

put

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

putMany

putMany(
source: AwaitIterable<Pair>,
options?: AbortOptions & PutManyOptionsExtension,
): AwaitGenerator<Key>
Store the given key/value pairs
Parameters
- source: AwaitIterable<Pair>
- Optionaloptions: AbortOptions & PutManyOptionsExtension
Returns AwaitGenerator<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}`)
}
```
Inherited from Store.putMany
- Defined in interface-store/dist/src/index.d.ts:62

query

query(
query: Query,
options?: AbortOptions & QueryOptionsExtension,
): AwaitGenerator<Pair>
Query the datastore.
Parameters
- query: Query
- Optionaloptions: AbortOptions & QueryOptionsExtension
Returns AwaitGenerator<Pair>
Example
```
// retrieve __all__ key/value pairs from the store
let list = []
for await (const { key, value } of store.query({})) {
  list.push(value)
}
console.log('ALL THE VALUES', list)
```
- Defined in interface-datastore/src/index.ts:158

queryKeys

queryKeys(
query: KeyQuery,
options?: AbortOptions & QueryKeysOptionsExtension,
): AwaitGenerator<Key>
Query the datastore.
Parameters
- query: KeyQuery
- Optionaloptions: AbortOptions & QueryKeysOptionsExtension
Returns AwaitGenerator<Key>
Example
```
// retrieve __all__ keys from the store
let list = []
for await (const key of store.queryKeys({})) {
  list.push(key)
}
console.log('ALL THE KEYS', key)
```
- Defined in interface-datastore/src/index.ts:173

Interface Datastore<HasOptionsExtension, PutOptionsExtension, PutManyOptionsExtension, GetOptionsExtension, GetManyOptionsExtension, DeleteOptionsExtension, DeleteManyOptionsExtension, QueryOptionsExtension, QueryKeysOptionsExtension, BatchOptionsExtension>

Type Parameters

Hierarchy (View Summary)

Implemented by

Index

Methods

Methods

batch

Returns Batch<BatchOptionsExtension>

Example

delete

Parameters

Returns Await<void>

Example

deleteMany

Parameters

Returns AwaitGenerator<Key>

Example

get

Parameters

Returns Await

Example

getMany

Parameters

Returns AwaitGenerator<Pair>

Example

has

Parameters

Returns Await<boolean>

Example

put

Parameters

Returns Await<Key>

Example

putMany

Parameters

Returns AwaitGenerator<Key>

Example

query

Parameters

Returns AwaitGenerator<Pair>

Example

queryKeys

Parameters

Returns AwaitGenerator<Key>

Example

Settings

On This Page