Skip to content

valkeyrie


valkeyrie / FromOptions

Interface: FromOptions<T> ​

Defined in: valkeyrie.ts:60

Options for creating a Valkeyrie database from an iterable.

Type Parameters ​

T ​

T

Properties ​

prefix ​

ts
prefix: Key;

Defined in: valkeyrie.ts:62

Prefix for all keys


keyProperty ​

ts
keyProperty: keyof T | (item: T) => KeyPart;

Defined in: valkeyrie.ts:64

Property name or function to extract the key part from each item


path? ​

ts
optional path: string;

Defined in: valkeyrie.ts:66

Optional path to the database file (defaults to in-memory if neither path nor driverFn are given)


driverFn? ​

ts
optional driverFn: DriverFactory;

Defined in: valkeyrie.ts:68

Optional function to provide a driver; takes precedence over path


serializer()? ​

ts
optional serializer: () => Serializer;

Defined in: valkeyrie.ts:70

Optional custom serializer

Returns ​

Serializer


destroyOnClose? ​

ts
optional destroyOnClose: boolean;

Defined in: valkeyrie.ts:72

Optional destroyOnClose flag (default: false)


expireIn? ​

ts
optional expireIn: number;

Defined in: valkeyrie.ts:74

Optional TTL for all entries (milliseconds)


onProgress()? ​

ts
optional onProgress: (processed: number, total?: number) => void;

Defined in: valkeyrie.ts:76

Optional progress callback

Parameters ​

processed ​

number

total? ​

number

Returns ​

void


onError? ​

ts
optional onError: "stop" | "continue";

Defined in: valkeyrie.ts:78

Optional error handling strategy (default: 'stop')


onErrorCallback()? ​

ts
optional onErrorCallback: (error: Error, item: T) => void;

Defined in: valkeyrie.ts:80

Optional callback for errors when onError is 'continue'

Parameters ​

error ​

Error

item ​

T

Returns ​

void

Released under the MIT License.