Class FsDatastore

A datastore backed by the file system.

Keys need to be sanitized before use, as they are written to the file system as is.

Hierarchy (View Summary)

BaseDatastore
- FsDatastore

Index

Constructors

constructor

new FsDatastore(location: string, init?: FsDatastoreInit): FsDatastore
Parameters
- location: string
- init: FsDatastoreInit = {}
Returns FsDatastore
Overrides BaseDatastore.constructor
- Defined in datastore-fs/src/index.ts:84

Properties

path

path: string

Methods

_all

_all(q: Query, options?: AbortOptions): AwaitGenerator<Pair>
Extending classes should override query or implement this method
Parameters
- q: Query
- Optionaloptions: AbortOptions
Returns AwaitGenerator<Pair>
Overrides BaseDatastore._all
- Defined in datastore-fs/src/index.ts:242

_allKeys

_allKeys(q: KeyQuery, options?: AbortOptions): AwaitGenerator<Key>
Extending classes should override queryKeys or implement this method
Parameters
- q: KeyQuery
- Optionaloptions: AbortOptions
Returns AwaitGenerator<Key>
Overrides BaseDatastore._allKeys
- Defined in datastore-fs/src/index.ts:277

_decode

_decode(file: string): Key
Calculate the original key, given the file name.
Parameters
- file: string
Returns Key
- Defined in datastore-fs/src/index.ts:139

_encode

_encode(key: Key): { dir: string; file: string }
Calculate the directory and file name for a given key.
Parameters
- key: Key
Returns { dir: string; file: string }
- Defined in datastore-fs/src/index.ts:124

batch

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

Returns Batch
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')
```
Inherited from BaseDatastore.batch
- Defined in datastore-core/dist/src/base.d.ts:11

close

close(): Promise<void>
Returns Promise<void>
- Defined in datastore-fs/src/index.ts:117

delete

delete(key: Key, options?: AbortOptions): Promise<void>
Remove the record for the passed key
Parameters
- key: Key
- Optionaloptions: AbortOptions
Returns Promise<void>
Example
```
await store.delete(new Key('awesome'))
console.log('deleted awesome content :(')
```
Overrides BaseDatastore.delete
- Defined in datastore-fs/src/index.ts:228

deleteMany

deleteMany(
source: AwaitIterable<Key>,
options?: AbortOptions,
): AwaitGenerator<Key>
Remove values for the passed keys
Parameters
- source: AwaitIterable<Key>
- Optionaloptions: AbortOptions
Returns AwaitGenerator<Key>
Example
```
const source = [new Key('awesome')]

for await (const key of store.deleteMany(source)) {
  console.log(`deleted content with key ${key}`)
}
```
Overrides BaseDatastore.deleteMany
- Defined in datastore-fs/src/index.ts:202

get

get(key: Key, options?: AbortOptions): Promise<Uint8Array<ArrayBufferLike>>
Retrieve the value stored under the given key
Parameters
- key: Key
- Optionaloptions: AbortOptions
Returns Promise<Uint8Array<ArrayBufferLike>>
Example
```
const value = await store.get(new Key('awesome'))
console.log('got content: %s', value.toString('utf8'))
// => got content: datastore
```
Overrides BaseDatastore.get
- Defined in datastore-fs/src/index.ts:178

getMany

getMany(
source: AwaitIterable<Key>,
options?: AbortOptions,
): AwaitGenerator<Pair>
Retrieve values for the passed keys
Parameters
- source: AwaitIterable<Key>
- Optionaloptions: AbortOptions
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"
}
```
Overrides BaseDatastore.getMany
- Defined in datastore-fs/src/index.ts:188

has

has(key: Key, options?: AbortOptions): Promise<boolean>
Check for the existence of a value for the passed key
Parameters
- key: Key
- Optionaloptions: AbortOptions
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 BaseDatastore.has
- Defined in datastore-fs/src/index.ts:215

open

open(): Promise<void>
Returns Promise<void>
- Defined in datastore-fs/src/index.ts:96

put

put(key: Key, val: Uint8Array, options?: AbortOptions): Promise<Key>
Store the passed value under the passed key
Parameters
- key: Key
- val: Uint8Array
- Optionaloptions: AbortOptions
Returns Promise<Key>
Example
```
await store.put([{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }])
```
Overrides BaseDatastore.put
- Defined in datastore-fs/src/index.ts:153

putMany

putMany(
source: AwaitIterable<Pair>,
options?: AbortOptions,
): AwaitGenerator<Key>
Store the given key/value pairs
Parameters
- source: AwaitIterable<Pair>
- Optionaloptions: AbortOptions
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}`)
}
```
Overrides BaseDatastore.putMany
- Defined in datastore-fs/src/index.ts:165

query

query(q: Query, options?: AbortOptions): AwaitGenerator<Pair>
Query the datastore.
Parameters
- q: Query
- Optionaloptions: AbortOptions
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)
```
Inherited from BaseDatastore.query
- Defined in datastore-core/dist/src/base.d.ts:20

queryKeys

queryKeys(q: KeyQuery, options?: AbortOptions): AwaitGenerator<Key>
Query the datastore.
Parameters
- q: KeyQuery
- Optionaloptions: AbortOptions
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)
```
Inherited from BaseDatastore.queryKeys
- Defined in datastore-core/dist/src/base.d.ts:21

Class FsDatastore

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FsDatastore

Properties

path

Methods

_all

Parameters

Returns AwaitGenerator<Pair>

_allKeys

Parameters

Returns AwaitGenerator<Key>

_decode

Parameters

Returns Key

_encode

Parameters

Returns { dir: string; file: string }

batch

Returns Batch

Example

close

Returns Promise<void>

delete

Parameters

Returns Promise<void>

Example

deleteMany

Parameters

Returns AwaitGenerator<Key>

Example

get

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

Example

getMany

Parameters

Returns AwaitGenerator<Pair>

Example

has

Parameters

Returns Promise<boolean>

Example

open

Returns Promise<void>

put

Parameters

Returns Promise<Key>

Example

putMany

Parameters

Returns AwaitGenerator<Key>

Example

query

Parameters

Returns AwaitGenerator<Pair>

Example

queryKeys

Parameters

Returns AwaitGenerator<Key>

Example

Settings

On This Page