Class RequestTracker

Represents a collection of webrequests Will only send update signal at most every delay Provides convenient aggregation of metrics.

Hierarchy

RequestTracker

Index

Constructors

Properties

all delay lastUpdate logs onUpdate sleeping source

Accessors

Methods

end fail start update

Constructors

constructor

new RequestTracker(source?: string, logger?: Logger): RequestTracker
Parameters
- Optional source: string
- Optional logger: Logger
Returns RequestTracker
- Defined in node_modules/vim-format/dist/requestTracker.d.ts:34

Properties

all

all: Map<string, Request>

delay

delay: number

lastUpdate

lastUpdate: number

logs

logs: Logger

onUpdate

onUpdate: ((self: RequestTracker) => void)

Type declaration

- (self: RequestTracker): void
- callback on update, called at most every delay time.
  Parameters
  - self: RequestTracker
  Returns void

sleeping

sleeping: boolean

source

source: string

Accessors

loaded

get loaded(): number
Returns the sum of .loaded across all requests

Returns number
- Defined in node_modules/vim-format/dist/requestTracker.d.ts:38

total

get total(): number
Returns the sum of .total across all requests

Returns number
- Defined in node_modules/vim-format/dist/requestTracker.d.ts:42

Methods

end

end(field: string): void
Notify a webrequest of success
Parameters
- field: string
Returns void
- Defined in node_modules/vim-format/dist/requestTracker.d.ts:58

fail

fail(field: string): void
Notify a webrequest of failure
Parameters
- field: string
Returns void
- Defined in node_modules/vim-format/dist/requestTracker.d.ts:54

start

start(field: string): void
Starts tracking a new web request
Parameters
- field: string
Returns void
- Defined in node_modules/vim-format/dist/requestTracker.d.ts:46

update

update(field: string, progress: ProgressEvent<EventTarget>): void
Update an existing web request
Parameters
- field: string
- progress: ProgressEvent<EventTarget>
Returns void
- Defined in node_modules/vim-format/dist/requestTracker.d.ts:50

Generated using TypeDoc