valkeyrie / FromOptions
Interface: FromOptions<T>
Defined in: valkeyrie.ts:53
Options for creating a Valkeyrie database from an iterable.
Type Parameters
T
T
Properties
prefix
prefix: Key;Defined in: valkeyrie.ts:55
Prefix for all keys
keyProperty
keyProperty: keyof T | (item: T) => KeyPart;Defined in: valkeyrie.ts:57
Property name or function to extract the key part from each item
path?
optional path: string;Defined in: valkeyrie.ts:59
Optional path to the database file (defaults to in-memory)
serializer()?
optional serializer: () => Serializer;Defined in: valkeyrie.ts:61
Optional custom serializer
Returns
Serializer
destroyOnClose?
optional destroyOnClose: boolean;Defined in: valkeyrie.ts:63
Optional destroyOnClose flag (default: false)
expireIn?
optional expireIn: number;Defined in: valkeyrie.ts:65
Optional TTL for all entries (milliseconds)
onProgress()?
optional onProgress: (processed: number, total?: number) => void;Defined in: valkeyrie.ts:67
Optional progress callback
Parameters
processed
number
total?
number
Returns
void
onError?
optional onError: "stop" | "continue";Defined in: valkeyrie.ts:69
Optional error handling strategy (default: 'stop')
onErrorCallback()?
optional onErrorCallback: (error: Error, item: T) => void;Defined in: valkeyrie.ts:71
Optional callback for errors when onError is 'continue'
Parameters
error
Error
item
T
Returns
void