Class CacheManager

Hierarchy

EventEmitter<"ready" | "reset">
- CacheManager

Index

Constructors

constructor

new CacheManager(opts?: Partial<CacheManagerOptions>): CacheManager
Parameters
- Optional opts: Partial<CacheManagerOptions>
Returns CacheManager
Overrides EventEmitter<'ready' | 'reset'>.constructor
- Defined in src/CacheManager.class.ts:30

Properties

`Private` _entries

_entries: {
[uri: string]: CacheEntry;
}

Type declaration

[uri: string]: CacheEntry

`Private` _entryExpiresIn

_entryExpiresIn: number

`Private` _folder

_folder: string

`Private` _ready

_ready: boolean

`Private` _tmpFolder

_tmpFolder: string

`Readonly` folder

folder: string

`Static` prefixed

prefixed: string | boolean

Accessors

entries

get entries(): {
[uri: string]: CacheEntry;
}
Returns {
[uri: string]: CacheEntry;
}
- [uri: string]: CacheEntry
- Defined in src/CacheManager.class.ts:177

entryExpiresIn

get entryExpiresIn(): number
Returns number
- Defined in src/CacheManager.class.ts:181

ready

get ready(): boolean
Returns boolean
- Defined in src/CacheManager.class.ts:173

Methods

addListener

addListener<T>(event: T, fn: ((...args: any[]) => void), context?: any): CacheManager
Type Parameters
- T extends "ready" | "reset"
Parameters
- event: T
- fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- Optional context: any
Returns CacheManager
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

emit

emit<T>(event: T, ...args: any[]): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends "ready" | "reset"
Parameters
- event: T
- Rest ...args: any[]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): ("ready" | "reset")[]
Return an array listing the events for which the emitter has registered listeners.

Returns ("ready" | "reset")[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

getCacheSizeAsync

getCacheSizeAsync(withTmp?: boolean): Promise<number>
Parameters
- withTmp: boolean = false
Returns Promise<number>
- Defined in src/CacheManager.class.ts:147

getEntry

getEntry(uri: string): null | CacheEntry
Parameters
- uri: string
Returns null | CacheEntry
- Defined in src/CacheManager.class.ts:127

initAsync

initAsync(): Promise<void>
Returns Promise<void>
- Defined in src/CacheManager.class.ts:47

listenerCount

listenerCount(event: "ready" | "reset"): number
Return the number of listeners listening to a given event.
Parameters
- event: "ready" | "reset"
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event: T): ((...args: any[]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends "ready" | "reset"
Parameters
- event: T
Returns ((...args: any[]) => void)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

off

off<T>(event: T, fn?: ((...args: any[]) => void), context?: any, once?: boolean): CacheManager
Type Parameters
- T extends "ready" | "reset"
Parameters
- event: T
- Optional fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns CacheManager
Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T>(event: T, fn: ((...args: any[]) => void), context?: any): CacheManager
Add a listener for a given event.
Type Parameters
- T extends "ready" | "reset"
Parameters
- event: T
- fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- Optional context: any
Returns CacheManager
Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<T>(event: T, fn: ((...args: any[]) => void), context?: any): CacheManager
Add a one-time listener for a given event.
Type Parameters
- T extends "ready" | "reset"
Parameters
- event: T
- fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- Optional context: any
Returns CacheManager
Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54

removeAllListeners

removeAllListeners(event?: "ready" | "reset"): CacheManager
Remove all listeners, or those of the specified event.
Parameters
- Optional event: "ready" | "reset"
Returns CacheManager
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event: T, fn?: ((...args: any[]) => void), context?: any, once?: boolean): CacheManager
Remove the listeners of a given event.
Type Parameters
- T extends "ready" | "reset"
Parameters
- event: T
- Optional fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns CacheManager
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

resetAsync

resetAsync(): Promise<void>
Returns Promise<void>
- Defined in src/CacheManager.class.ts:104

Class CacheManager

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional opts: Partial<CacheManagerOptions>

Returns CacheManager

Properties

Private _entries

Type declaration

[uri: string]: CacheEntry

Private _entryExpiresIn

Private _folder

Private _ready

Private _tmpFolder

Readonly folder

Static prefixed

Accessors

entries

Returns { [uri: string]: CacheEntry; }

[uri: string]: CacheEntry

entryExpiresIn

Returns number

ready

Returns boolean

Methods

addListener

Type Parameters

T extends "ready" | "reset"

Parameters

event: T

fn: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Optional context: any

Returns CacheManager

emit

Type Parameters

T extends "ready" | "reset"

Parameters

event: T

Rest ...args: any[]

Returns boolean

eventNames

Returns ("ready" | "reset")[]

getCacheSizeAsync

Parameters

withTmp: boolean = false

Returns Promise<number>

getEntry

Parameters

uri: string

Returns null | CacheEntry

initAsync

Returns Promise<void>

listenerCount

Parameters

event: "ready" | "reset"

Returns number

listeners

Type Parameters

T extends "ready" | "reset"

Parameters

event: T

Returns ((...args: any[]) => void)[]

off

Type Parameters

T extends "ready" | "reset"

Parameters

event: T

Optional fn: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

`Optional` opts: Partial<CacheManagerOptions>

`Private` _entries

`Private` _entryExpiresIn

`Private` _folder

`Private` _ready

`Private` _tmpFolder

`Readonly` folder

`Static` prefixed

Returns {
[uri: string]: CacheEntry;
}

`Rest` ...args: any[]

`Optional` context: any

`Rest` ...args: any[]

`Optional` fn: ((...args: any[]) => void)

`Rest` ...args: any[]

`Optional` context: any

`Optional` once: boolean

`Rest` ...args: any[]

`Optional` context: any

`Rest` ...args: any[]

`Optional` context: any

`Optional` event: "ready" | "reset"

`Optional` fn: ((...args: any[]) => void)

`Rest` ...args: any[]

`Optional` context: any

`Optional` once: boolean