Class Store<Ready>

constructor

• new Store<Ready>(): Store<Ready>

• Type Parameters

  • Ready extends boolean

  Returns Store<Ready>

dest

query

Readonly ready

[asyncIterator]

• [asyncIterator](): AsyncIterableIterator<Metadata>

• Iterate over meta files stored on disk.

  Returns AsyncIterableIterator<Metadata>

  Example

  const store = new Store();
  for await (meta of store) {}
  Copy

check

• check(key, __meta?): string | false

• Parameters

  • key: Key

  • Optional __meta: typeof meta_symbol

    INTERNAL USAGE ONLY

  Returns string | false

  If key exists, return full path to the file, and false otherwise.

delete

• delete(key): Promise<boolean>

• Parameters

  • key: Key

  Returns Promise<boolean>

  true if an element in the Store existed and has been removed, or false if the element does not exist.

insert

• insert(pairs): Promise<void>

• Insert items into the store.

  Parameters

  • pairs: RawCachePair<Buffer>[]

  Returns Promise<void>

load

• load(size): Promise<RawCacheEntry<Buffer>[]>

• Loaded elements are reverse chronologically sorted

  Parameters

  • size: number

    limits array size

  Returns Promise<RawCacheEntry<Buffer>[]>

loadMeta

• loadMeta(size?): Promise<MetadataSource[]>

• Loaded elements are reverse chronologically sorted

  Parameters

  • Optional size: number

    limits array size

  Returns Promise<MetadataSource[]>

reset

• reset(): Promise<void>

• Returns Promise<void>

retrieve

• retrieve(key, _skip_check?): Promise<undefined | Buffer>

• Parameters

  • key: Key

  • Optional _skip_check: typeof skip_check_symbol

    INTERNAL USAGE ONLY

  Returns Promise<undefined | Buffer>

retrieveMeta

• retrieveMeta(key, _skip_check?): Promise<undefined | Metadata>

• Parameters

  • key: Key

  • Optional _skip_check: typeof skip_check_symbol

    INTERNAL USAGE ONLY

  Returns Promise<undefined | Metadata>

setup

• setup(dest, clean?): Promise<Store<true>>

• Parameters

  • dest: string

  • Optional clean: boolean

    Clean up target folder

  Returns Promise<Store<true>>

Static start

• start(dest, clean?): Promise<Store<true>>

• Create new, ready to use, Store instance

  Parameters

  • dest: string

  • Optional clean: boolean

  Returns Promise<Store<true>>