IdleService — Angular

Service which configures custom 'on idle' behavior for Angular features like @defer.

API

interface IdleService {
  requestOnIdle(callback: (deadline?: IdleDeadline | undefined) => void, options?: IdleRequestOptions | undefined): number;
  cancelOnIdle(id: number): void;
}

requestOnIdle

number

Schedule callback to be executed when the current application or browser is considered idle.

@paramcallback(deadline?: IdleDeadline | undefined) => void

@paramoptionsIdleRequestOptions | undefined

@returnsnumber

an id which allows the scheduled callback to be cancelled before it executes.

cancelOnIdle

void

Cancel a previously scheduled callback using the id associated with it.

@paramidnumber

@returnsvoid