Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Watcher

表示一个监听器。

Hierarchy

Index

Properties

delay

delay: number = 151

监听延时回调的毫秒数。

desc

设置一定的延时可以避免在短时间内重复处理相同的文件。

inited

inited: boolean = false

判断当前监听器是否已初始化。

rootLists

rootLists: RootFileList[] = []

获取所有根节点列表。

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

isWatching

  • get isWatching(): boolean

Methods

add

  • add(path: string, callback?: function): void
  • 添加要监听的文件或文件夹。

    Parameters

    • path: string

      要添加的文件或文件夹路径。

    • Optional callback: function

      开始监听的回调函数。

        • (error: ErrnoException | null, path: string): void
        • Parameters

          • error: ErrnoException | null
          • path: string

          Returns void

    Returns void

addDep

  • addDep(file: File, path: string): void

addListener

  • addListener(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

close

  • close(callback?: function): void
  • 删除所有监听器。

    Parameters

    • Optional callback: function

      删除完成后的回调函数。

        • (): void
        • Returns void

    Returns void

emit

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

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]
  • Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number
  • Returns number

ignored

  • ignored(path: string): boolean
  • 判断是否忽略指定的路径。

    Parameters

    • path: string

      要判断的文件或文件夹绝对路径。

    Returns boolean

    如果应忽略指定的路径则返回 true,否则返回 false。

listenerCount

  • listenerCount(type: string | symbol): number
  • Parameters

    • type: string | symbol

    Returns number

listeners

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

    • event: string | symbol

    Returns Function[]

on

  • on(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

Protected onChange

  • onChange(path: string, stats: Stats, lastWriteTime: number): void
  • 当监听到文件改变后执行。

    Parameters

    • path: string

      相关的文件绝对路径。

    • stats: Stats

      相关的文件属性对象。

    • lastWriteTime: number

      最后修改时间。

    Returns void

Protected onCreate

  • onCreate(path: string, stats: Stats): void
  • 当监听到文件创建后执行。

    Parameters

    • path: string

      相关的文件绝对路径。

    • stats: Stats

      文件属性对象。

    Returns void

Protected onCreateDir

  • onCreateDir(path: string, entries: string[]): void

Protected onDelete

  • onDelete(path: string, lastWriteTime: number): void
  • 当监听到文件删除后执行。

    Parameters

    • path: string

      相关的文件绝对路径。

    • lastWriteTime: number

      最后修改时间。

    Returns void

Protected onDeleteDir

  • onDeleteDir(path: string, lastEntries: string[]): void

Protected onError

  • onError(e: ErrnoException, path: string): void
  • 当监听发生错误后执行。

    Parameters

    • e: ErrnoException

      相关的错误对象。

    • path: string

      相关的文件绝对路径。

    Returns void

once

  • once(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

remove

  • remove(path: string): void

removeAllListeners

  • removeAllListeners(event?: string | symbol): this
  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this
  • Parameters

    • n: number

    Returns this

start

  • 执行并开始监听指定的任务。

    Parameters

    • task: AsyncCallback

      执行的任务名。

    • Optional callback: function

      开始监听的回调。

        • (): void
        • Returns void

    Returns void

Static listenerCount

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

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(event: "delete", listener: function): this
  • on(event: "rebuild", listener: function): this
  • on(event: "delete", listener: function): this
  • on(event: "deleteDir", listener: function): this
  • on(event: "create", listener: function): this
  • on(event: "createDir", listener: function): this
  • on(event: "change", listener: function): this
  • on(event: "error", listener: function): this
  • on(event: string | symbol, listener: Function): this
  • 绑定一个文件删除事件。

    Parameters

    • event: "delete"

      要绑定的事件名。

    • listener: function

      要绑定的事件监听器。

      • @param path 相关的文件绝对路径。
      • @param lastWriteTime 最后修改时间。
        • (path: string, lastWriteTime: number): void
        • Parameters

          • path: string
          • lastWriteTime: number

          Returns void

    Returns this

  • 绑定一个重新生成事件。

    Parameters

    • event: "rebuild"
    • listener: function
        • (changes: string[], deletes: string[]): void
        • Parameters

          • changes: string[]
          • deletes: string[]

          Returns void

    Returns this

  • 绑定一个文件删除事件。

    Parameters

    • event: "delete"
    • listener: function
        • (path: string, lastWriteTime: number): void
        • Parameters

          • path: string
          • lastWriteTime: number

          Returns void

    Returns this

  • 绑定一个文件夹删除事件。

    Parameters

    • event: "deleteDir"
    • listener: function
        • (path: string, lastEntries: string[]): void
        • Parameters

          • path: string
          • lastEntries: string[]

          Returns void

    Returns this

  • 绑定一个文件创建事件。

    Parameters

    • event: "create"
    • listener: function
        • (path: string, stats: Stats): void
        • Parameters

          • path: string
          • stats: Stats

          Returns void

    Returns this

  • 绑定一个文件夹删除事件。

    Parameters

    • event: "createDir"
    • listener: function
        • (path: string, entries: string[]): void
        • Parameters

          • path: string
          • entries: string[]

          Returns void

    Returns this

  • 绑定一个文件改变事件。

    Parameters

    • event: "change"
    • listener: function
        • (path: string, stats: Stats, lastWriteTime: number): void
        • Parameters

          • path: string
          • stats: Stats
          • lastWriteTime: number

          Returns void

    Returns this

  • 绑定一个错误事件。

    Parameters

    • event: "error"
    • listener: function
        • (error: ErrnoException, path: string): void
        • Parameters

          • error: ErrnoException
          • path: string

          Returns void

    Returns this

  • 绑定一个事件。

    Parameters

    • event: string | symbol

      要绑定的事件名。

    • listener: Function

      要绑定的事件监听器。

    Returns this

Object literals

watchOptions

watchOptions: object

获取传递给原生监听器的选项。

encoding

encoding: string = "buffer"

默认文件名编码。

persistent

persistent: boolean = true

是否持久监听。如果设为 false 则在监听到一次改动后立即退出监听。

recursive

recursive: boolean = parseFloat(process.version.slice(1)) >= 4.5 && (process.platform === "win32" || process.platform === "darwin")

是否使用原生的递归监听支持。

Generated using TypeDoc