@delicious-simplicity/typekey/dist/index.d.ts

TypeScript library for generating cache keys with type safety

import { KeyDictionaryError } from './error';
type KeyParams = Record<string, string | number | boolean | null | undefined>;
type KeyPrefixConfig = Record<string, string[]>;
type KeyPrefixParams<T extends KeyPrefixConfig> = {
    [K in keyof T]: Record<T[K][number], KeyParams[T[K][number]]>;
};
type KeyDictionaryOptionsBase = {
    maxKeyLength?: number;
    throwOnMaxLengthViolation?: false;
};
type KeyDictionaryOptionsStrict = {
    maxKeyLength: number;
    throwOnMaxLengthViolation: true;
};
type KeyDictionaryOptions = KeyDictionaryOptionsBase | KeyDictionaryOptionsStrict;
declare class KeyDictionary<T extends KeyPrefixConfig> {
    private prefixParamsMap;
    private maxKeyLength;
    private throwOnMaxLengthViolation;
    constructor(config: T, options?: KeyDictionaryOptions);
    private hashKeyParts;
    generateKey<K extends keyof T>(prefix: K, params: KeyPrefixParams<T>[K]): string;
}
export { KeyDictionary, KeyDictionaryError, type KeyDictionaryOptions, type KeyPrefixConfig };