Class MaxKeyLengthStorage<T>

A KeyValueStorage that hashes keys in case they would be longer than the set limit. Hashed keys are prefixed with a certain value to prevent issues with incoming keys that are already hashed. The default max length is 150 and the default prefix is $hash$.

This class mostly exists to prevent issues when writing storage entries to disk. Keys that are too long would cause issues with the file name limit. For this reason, only the part after the last / in a key is hashed, to preserve the expected file structure.

Type Parameters

  • T

Hierarchy

  • MaxKeyLengthStorage

Implements

Constructors

constructor

Properties

hashPrefix logger maxKeyLength source

Methods

delete entries get getKey getKeyWithCheck has set wrapPayload

Constructors

constructor

Properties

Protected Readonly hashPrefix

hashPrefix: string

Protected Readonly logger

logger: Logger = ...

Protected Readonly maxKeyLength

maxKeyLength: number

Protected Readonly source

source: KeyValueStorage<string, Entry<T>>

Methods

delete

entries

get

Protected getKey

  • Hashes the last part of the key if it is too long. Otherwise, just returns the key.

    Parameters

    • key: string
    • Optional parts: string[]

    Returns string

Protected getKeyWithCheck

  • Similar to getKey but checks to make sure the key does not already contain the prefix. Only necessary for set calls.

    Parameters

    • key: string

    Returns string

has

set

Protected wrapPayload

Settings

Member Visibility

Theme

On This Page