Skip to main content
Version: v1

TST Class

Signature​

export declare class TST<T>

Type Parameters​

ParameterDescription
T

Methods​

MethodReturn TypeDescription
get(key)T | undefined
keysWithPrefix(text)string[]
map(fn)void
neighbors(text, distance)ProxString<T>[]
pairsWithPrefix(text)TSTResult<T>[]
put(key, val)void
size()number

Method Details​

get​

Signature​

get(key: string): T | undefined;

Parameters​

ParameterTypeDescription
keystring

Returns​

Return type: T | undefined

keysWithPrefix​

Signature​

keysWithPrefix(text: string): string[];

Parameters​

ParameterTypeDescription
textstring

Returns​

Return type: string[]

map​

Signature​

map(fn: (key: string, val: T) => void): void;

Parameters​

ParameterTypeDescription
fn(key: string, val: T) => void

neighbors​

Signature​

neighbors(text: string, distance?: number): ProxString<T>[];

Parameters​

ParameterModifiersTypeDescription
textstring
distanceoptionalnumber

Returns​

Return type: ProxString<T>[]

pairsWithPrefix​

Signature​

pairsWithPrefix(text: string): TSTResult<T>[];

Parameters​

ParameterTypeDescription
textstring

Returns​

Return type: TSTResult<T>[]

put​

Signature​

put(key: string, val: T): void;

Parameters​

ParameterTypeDescription
keystring
valT

size​

Signature​

size(): number;

Returns​

Return type: number