FileKVStoreOptions

Options of createFileKVStore.

Import#

import type { FileKVStoreOptions } from "@shadow-js/dusk/node";

Signature#

interface FileKVStoreOptions {
  /** The folder the files live in (created when first written). */
  readonly directory: string;
  /** Largest value in bytes of JSON text. Default 1 MiB. */
  readonly maxValueBytes?: number;
  /** Clock in epoch milliseconds. Default `Date.now`. */
  readonly now?: () => number;
}

Members#

Name	Type	Description
`directory`	`readonly directory: string`	The folder the files live in (created when first written).
`maxValueBytes?`	`readonly maxValueBytes?: number`	Largest value in bytes of JSON text. Default 1 MiB.
`now?`	`readonly now?: () => number`	Clock in epoch milliseconds. Default `Date.now`.