Globals

Class CustomStatWatcher<P>

Type parameters

P: Path

Hierarchy

EventEmitter
- CustomStatWatcher

Implements

EventEmitter<this> & object

Constructors

constructor

Properties

Constructors

Private constructor

new CustomStatWatcher(fakeFs: FakeFS<P>, path: P, __namedParameters?: object): CustomStatWatcher

Overrides WatchManager.constructor
- Defined in packages/yarnpkg-fslib/sources/algorithms/watchFile/CustomStatWatcher.ts:53
Parameters
- fakeFs: FakeFS<P>
- path: P
- Default value __namedParameters: object = {}
  - bigint: boolean
Returns CustomStatWatcher

Properties

bigint

bigint: boolean

Private changeListeners

changeListeners: Map<WatchFileCallback, Timeout> = new Map()

fakeFs

fakeFs: FakeFS<P>

Private lastStats

lastStats: Stats | BigIntStats

path

path: P

Private startTimeout

startTimeout: Timeout | null = null

Private status

status: Status = Status.Ready

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener(event: string | symbol, listener: function): this

Inherited from CustomStatWatcher.addListener
- Defined in .yarn/cache/@types-node-npm-13.7.0-6051c9578d-ccc4eb30fd.zip/node_modules/@types/node/globals.d.ts:541
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from CustomStatWatcher.emit
- Defined in .yarn/cache/@types-node-npm-13.7.0-6051c9578d-ccc4eb30fd.zip/node_modules/@types/node/globals.d.ts:551
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from CustomStatWatcher.eventNames
- Defined in .yarn/cache/@types-node-npm-13.7.0-6051c9578d-ccc4eb30fd.zip/node_modules/@types/node/globals.d.ts:556
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from CustomStatWatcher.getMaxListeners
- Defined in .yarn/cache/@types-node-npm-13.7.0-6051c9578d-ccc4eb30fd.zip/node_modules/@types/node/globals.d.ts:548
Returns number

hasChangeListeners

hasChangeListeners(): boolean

- Defined in packages/yarnpkg-fslib/sources/algorithms/watchFile/CustomStatWatcher.ts:162
Returns boolean

listenerCount

listenerCount(type: string | symbol): number

Inherited from CustomStatWatcher.listenerCount
- Defined in .yarn/cache/@types-node-npm-13.7.0-6051c9578d-ccc4eb30fd.zip/node_modules/@types/node/globals.d.ts:552
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from CustomStatWatcher.listeners
- Defined in .yarn/cache/@types-node-npm-13.7.0-6051c9578d-ccc4eb30fd.zip/node_modules/@types/node/globals.d.ts:549
Parameters
- event: string | symbol
Returns Function[]

makeInterval

makeInterval(opts: ListenerOptions): Timeout

- Defined in packages/yarnpkg-fslib/sources/algorithms/watchFile/CustomStatWatcher.ts:115
Creates an interval whose callback compares the current stats with the previous stats and notifies all listeners in case of changes.

Parameters
- opts: ListenerOptions
Returns Timeout

off

off(event: string | symbol, listener: function): this

Inherited from CustomStatWatcher.off
- Defined in .yarn/cache/@types-node-npm-13.7.0-6051c9578d-ccc4eb30fd.zip/node_modules/@types/node/globals.d.ts:545
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: string | symbol, listener: function): this

Inherited from CustomStatWatcher.on
- Defined in .yarn/cache/@types-node-npm-13.7.0-6051c9578d-ccc4eb30fd.zip/node_modules/@types/node/globals.d.ts:542
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: string | symbol, listener: function): this

Inherited from CustomStatWatcher.once
- Defined in .yarn/cache/@types-node-npm-13.7.0-6051c9578d-ccc4eb30fd.zip/node_modules/@types/node/globals.d.ts:543
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from CustomStatWatcher.prependListener
- Defined in .yarn/cache/@types-node-npm-13.7.0-6051c9578d-ccc4eb30fd.zip/node_modules/@types/node/globals.d.ts:554
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from CustomStatWatcher.prependOnceListener
- Defined in .yarn/cache/@types-node-npm-13.7.0-6051c9578d-ccc4eb30fd.zip/node_modules/@types/node/globals.d.ts:555
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from CustomStatWatcher.rawListeners
- Defined in .yarn/cache/@types-node-npm-13.7.0-6051c9578d-ccc4eb30fd.zip/node_modules/@types/node/globals.d.ts:550
Parameters
- event: string | symbol
Returns Function[]

ref

ref(): this

- Defined in packages/yarnpkg-fslib/sources/algorithms/watchFile/CustomStatWatcher.ts:169
Refs all stored intervals.

Returns this

registerChangeListener

registerChangeListener(listener: WatchFileCallback, opts: ListenerOptions): void

- Defined in packages/yarnpkg-fslib/sources/algorithms/watchFile/CustomStatWatcher.ts:134
Registers a listener and assigns it an interval.

Parameters
- listener: WatchFileCallback
- opts: ListenerOptions
Returns void

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from CustomStatWatcher.removeAllListeners
- Defined in .yarn/cache/@types-node-npm-13.7.0-6051c9578d-ccc4eb30fd.zip/node_modules/@types/node/globals.d.ts:546
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from CustomStatWatcher.removeListener
- Defined in .yarn/cache/@types-node-npm-13.7.0-6051c9578d-ccc4eb30fd.zip/node_modules/@types/node/globals.d.ts:544
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from CustomStatWatcher.setMaxListeners
- Defined in .yarn/cache/@types-node-npm-13.7.0-6051c9578d-ccc4eb30fd.zip/node_modules/@types/node/globals.d.ts:547
Parameters
- n: number
Returns this

start

start(): void

- Defined in packages/yarnpkg-fslib/sources/algorithms/watchFile/CustomStatWatcher.ts:65
Returns void

stat

stat(): Stats | BigIntStats

- Defined in packages/yarnpkg-fslib/sources/algorithms/watchFile/CustomStatWatcher.ts:96
Returns Stats | BigIntStats

stop

stop(): void

- Defined in packages/yarnpkg-fslib/sources/algorithms/watchFile/CustomStatWatcher.ts:84
Returns void

unref

unref(): this

- Defined in packages/yarnpkg-fslib/sources/algorithms/watchFile/CustomStatWatcher.ts:179
Unrefs all stored intervals.

Returns this

unregisterAllChangeListeners

unregisterAllChangeListeners(): void

- Defined in packages/yarnpkg-fslib/sources/algorithms/watchFile/CustomStatWatcher.ts:156
Unregisters all listeners and clears all assigned intervals.

Returns void

unregisterChangeListener

unregisterChangeListener(listener: WatchFileCallback): void

- Defined in packages/yarnpkg-fslib/sources/algorithms/watchFile/CustomStatWatcher.ts:143
Unregisters the listener and clears the assigned interval.

Parameters
- listener: WatchFileCallback
Returns void

Static create

create<P>(fakeFs: FakeFS<P>, path: P, opts?: CustomStatWatcherOptions): CustomStatWatcher<P>

- Defined in packages/yarnpkg-fslib/sources/algorithms/watchFile/CustomStatWatcher.ts:47
Type parameters
- P: Path
Parameters
- fakeFs: FakeFS<P>
- path: P
- Optional opts: CustomStatWatcherOptions
Returns CustomStatWatcher<P>

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from CustomStatWatcher.listenerCount
- Defined in .yarn/cache/@types-node-npm-13.7.0-6051c9578d-ccc4eb30fd.zip/node_modules/@types/node/events.d.ts:44
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc