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

Constructors

constructor

Properties

createIfMissing deleteManyConcurrency errorIfExists extension getManyConcurrency path putManyConcurrency

Methods

_all _allKeys _decode _encode close delete deleteMany get getMany has open put putMany

Constructors

constructor

Properties

Private Readonly createIfMissing

createIfMissing: boolean

Private Readonly deleteManyConcurrency

deleteManyConcurrency: number

Private Readonly errorIfExists

errorIfExists: boolean

Private Readonly extension

extension: string

Private Readonly getManyConcurrency

getManyConcurrency: number

path

path: string

Private Readonly putManyConcurrency

putManyConcurrency: number

Methods

_all

_allKeys

_decode

  • _decode(file: string): Key

  • Calculate the original key, given the file name.

    Parameters

    • file: string

    Returns Key

_encode

  • _encode(key: Key): {
        dir: string;
        file: string;
    }

  • Calculate the directory and file name for a given key.

    Parameters

    Returns {
        dir: string;
        file: string;
    }

    • dir: string
    • file: string

close

delete

  • Delete the record under the given key

    Parameters

    Returns Promise<void>

deleteMany

get

getMany

has

  • Check for the existence of the given key

    Parameters

    Returns Promise<boolean>

open

put

putMany

Settings

Member Visibility

Theme