Class LazyStorage

Hierarchy

EventEmitter
- LazyStorage

Index

Constructors

constructor

Methods

clear close del flushAll flushStats get getTtl has keys list mdel mget mset on remove set stats take ttl

Constructors

constructor

new LazyStorage(options?: Options): LazyStorage
Parameters
- Optional options: Options
Returns LazyStorage

Overrides EventEmitter.constructor

Methods

clear

clear(): void
Alias for flushAll()

Returns void

close

close(): void
Closes the storage and halts the check interval

Returns void

del

del<KeyType>(key: KeyType): number
Deletes the value(s) with the specified key
Type Parameters
- KeyType = any
Parameters
- key: KeyType
Returns number

flushAll

flushAll(): void
Flushes all records from storage

Returns void

flushStats

flushStats(): void
Flushes the storage statistics

Returns void

get

get<ValueType, KeyType>(key: KeyType): undefined | ValueType
Retrieves the value with the given key
Type Parameters
- ValueType = any
- KeyType = any
Parameters
- key: KeyType
Returns undefined | ValueType

getTtl

getTtl<KeyType>(key: KeyType): undefined | number
Retrieves the current ttl of the specified key
Type Parameters
- KeyType = any
Parameters
- key: KeyType
Returns undefined | number

has

has<KeyType>(key: KeyType): boolean
Checks if the given key exists
Type Parameters
- KeyType = any
Parameters
- key: KeyType
Returns boolean

keys

keys<KeyType>(): KeyType[]
Retrieves a list of all keys
Type Parameters
- KeyType = any
Returns KeyType[]

list

list<ValueType, KeyType>(): Map<KeyType, ValueType>
Retrieves a map of all keys and values
Type Parameters
- ValueType = any
- KeyType = any
Returns Map<KeyType, ValueType>

mdel

mdel<KeyType>(keys: KeyType[]): number
Mass deletes values with the specified keys
Type Parameters
- KeyType = any
Parameters
- keys: KeyType[]
Returns number

mget

mget<ValueType, KeyType>(keys: KeyType[]): Map<KeyType, ValueType>
Mass retrieves values with the specified keys
Type Parameters
- ValueType = any
- KeyType = any
Parameters
- keys: KeyType[]
Returns Map<KeyType, ValueType>

mset

mset<ValueType, KeyType>(keys: KeyType[], values: ValueType[], ttl?: number): boolean
Mass sets values with the specified keys
Type Parameters
- ValueType = any
- KeyType = any
Parameters
- keys: KeyType[]
- values: ValueType[]
- ttl: number = ...
Returns boolean

on

on(event: "set", listener: ((key: any, value: any) => void)): LazyStorage
Parameters
- event: "set"
- listener: ((key: any, value: any) => void)
  - - (key: any, value: any): void
    - Parameters
      
      key: any
      
      value: any
      
      Returns void
Returns LazyStorage

Overrides EventEmitter.on
on(event: "expired", listener: ((key: any, value: any) => void)): LazyStorage
Parameters
- event: "expired"
- listener: ((key: any, value: any) => void)
  - - (key: any, value: any): void
    - Parameters
      
      key: any
      
      value: any
      
      Returns void
Returns LazyStorage

Overrides EventEmitter.on
on(event: "del", listener: ((key: any, value: any) => void)): LazyStorage
Parameters
- event: "del"
- listener: ((key: any, value: any) => void)
  - - (key: any, value: any): void
    - Parameters
      
      key: any
      
      value: any
      
      Returns void
Returns LazyStorage

Overrides EventEmitter.on
on(event: "flush", listener: (() => void)): LazyStorage
Parameters
- event: "flush"
- listener: (() => void)
  - - (): void
    - Returns void
Returns LazyStorage

Overrides EventEmitter.on
on(event: "flush_stats", listener: (() => void)): LazyStorage
Parameters
- event: "flush_stats"
- listener: (() => void)
  - - (): void
    - Returns void
Returns LazyStorage

Overrides EventEmitter.on
on(event: "error", listener: ((error: Error) => void)): LazyStorage
Parameters
- event: "error"
- listener: ((error: Error) => void)
  - - (error: Error): void
    - Parameters
      
      error: Error
      
      Returns void
Returns LazyStorage

Overrides EventEmitter.on

remove

remove<KeyType>(key: KeyType): number
Alias for del()
Type Parameters
- KeyType = any
Parameters
- key: KeyType
Returns number

set

set<ValueType, KeyType>(key: KeyType, value: ValueType, ttl?: number): boolean
Sets the value for the specified key
Type Parameters
- ValueType = any
- KeyType = any
Parameters
- key: KeyType
- value: ValueType
- ttl: number = ...
Returns boolean

stats

stats(): {
    hits: number;
    keys: number;
    ksize: number;
    misses: number;
    vsize: number;
}
Returns storage statistics

Returns {
    hits: number;
    keys: number;
    ksize: number;
    misses: number;
    vsize: number;
}
- hits: number
- keys: number
- ksize: number
- misses: number
- vsize: number

take

take<ValueType, KeyType>(key: KeyType): undefined | ValueType
Retrieves the value with the specified key and immediately deletes it from storage
Type Parameters
- ValueType = any
- KeyType = any
Parameters
- key: KeyType
Returns undefined | ValueType

ttl

ttl<KeyType>(key: KeyType, ttl?: number): boolean
Updates the ttl for the specified key
Type Parameters
- KeyType = any
Parameters
- key: KeyType
- ttl: number = ...
Returns boolean

Class LazyStorage

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Optional options: Options

Returns LazyStorage

Methods

clear

Returns void

close

Returns void

del

Type Parameters

KeyType = any

Parameters

key: KeyType

Returns number

flushAll

Returns void

flushStats

Returns void

get

Type Parameters

ValueType = any

KeyType = any

Parameters

key: KeyType

Returns undefined | ValueType

getTtl

Type Parameters

KeyType = any

Parameters

key: KeyType

Returns undefined | number

has

Type Parameters

KeyType = any

Parameters

key: KeyType

Returns boolean

keys

Type Parameters

KeyType = any

Returns KeyType[]

list

Type Parameters

ValueType = any

KeyType = any

Returns Map<KeyType, ValueType>

mdel

Type Parameters

KeyType = any

Parameters

keys: KeyType[]

Returns number

mget

Type Parameters

ValueType = any

KeyType = any

Parameters

keys: KeyType[]

Returns Map<KeyType, ValueType>

mset

Type Parameters

ValueType = any

KeyType = any

Parameters

keys: KeyType[]

values: ValueType[]

ttl: number = ...

Returns boolean

on

Parameters

event: "set"

listener: ((key: any, value: any) => void)

Parameters

`Optional` options: Options

Returns {
hits: number;
keys: number;
ksize: number;
misses: number;
vsize: number;
}