Class CacheEntry

Hierarchy

EventEmitter<"update">
- CacheEntry

Index

Constructors

constructor

new CacheEntry(__namedParameters: CacheEntryOptions): CacheEntry
Parameters
- __namedParameters: CacheEntryOptions
Returns CacheEntry
Overrides EventEmitter<'update'>.constructor
- Defined in src/CacheEntry.class.ts:58

Properties

`Private` _entryExpiresIn

_entryExpiresIn: number

`Private` `Optional` _error

_error?: any

`Private` _expiresIn

_expiresIn: undefined | Date

`Private` _path

_path: string

`Private` _progress

_progress: number

`Private` _status

_status: CacheEntryStatus

`Private` `Optional` _task

_task?: DownloadResumable

`Private` _tmpPath

_tmpPath: string

`Readonly` uri

uri: string

`Static` prefixed

prefixed: string | boolean

Accessors

entryExpiresIn

get entryExpiresIn(): number
Returns number
- Defined in src/CacheEntry.class.ts:327

error

get error(): any
Returns any
- Defined in src/CacheEntry.class.ts:323

expiresIn

get expiresIn(): undefined | Date
Returns undefined | Date
- Defined in src/CacheEntry.class.ts:331

path

get path(): null | string
Returns null | string
- Defined in src/CacheEntry.class.ts:311

progress

get progress(): number
Returns number
- Defined in src/CacheEntry.class.ts:319

status

get status(): CacheEntryStatus
Returns CacheEntryStatus
- Defined in src/CacheEntry.class.ts:315

Methods

addListener

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

cancelAsync

cancelAsync(): Promise<void>
Returns Promise<void>
- Defined in src/CacheEntry.class.ts:253

checkExpireStatus

checkExpireStatus(): void
Returns void
- Defined in src/CacheEntry.class.ts:300

downloadAsync

downloadAsync(options?: CacheEntryDownloadOptions): Promise<string>
Parameters
- Optional options: CacheEntryDownloadOptions
Returns Promise<string>
- Defined in src/CacheEntry.class.ts:153

emit

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

eventNames

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

Returns "update"[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

listenerCount

listenerCount(event: "update"): number
Return the number of listeners listening to a given event.
Parameters
- event: "update"
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 "update"
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): CacheEntry
Type Parameters
- T extends "update"
Parameters
- event: T
- Optional fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns CacheEntry
Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

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

`Private` onCompleteAsync

onCompleteAsync(): Promise<void>
Returns Promise<void>
- Defined in src/CacheEntry.class.ts:92

`Private` onTaskErrorAsync

onTaskErrorAsync(e: any): Promise<void>
Parameters
- e: any
Returns Promise<void>
- Defined in src/CacheEntry.class.ts:136

`Private` onUpdate

onUpdate(): void
Returns void
- Defined in src/CacheEntry.class.ts:335

`Private` onUpdateProgress

onUpdateProgress(data: DownloadProgressData): void
Parameters
- data: DownloadProgressData
Returns void
- Defined in src/CacheEntry.class.ts:87

once

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

pauseAsync

pauseAsync(): Promise<DownloadPauseState>
Returns Promise<DownloadPauseState>
- Defined in src/CacheEntry.class.ts:231

removeAllListeners

removeAllListeners(event?: "update"): CacheEntry
Remove all listeners, or those of the specified event.
Parameters
- Optional event: "update"
Returns CacheEntry
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): CacheEntry
Remove the listeners of a given event.
Type Parameters
- T extends "update"
Parameters
- event: T
- Optional fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns CacheEntry
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

resetAsync

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

`Private` resetTaskAsync

resetTaskAsync(withTmpFile?: boolean): Promise<void>
Parameters
- withTmpFile: boolean = false
Returns Promise<void>
- Defined in src/CacheEntry.class.ts:118

resumeAsync

resumeAsync(): Promise<string>
Returns Promise<string>
- Defined in src/CacheEntry.class.ts:198

Generated using TypeDoc