KC's Workspace
    Preparing search index...

    Interface IWatchOptions

    interface IWatchOptions {
        encoding?:
            | "base64"
            | "binary"
            | "ascii"
            | "utf8"
            | "utf-8"
            | "utf16le"
            | "utf-16le"
            | "ucs2"
            | "ucs-2"
            | "base64url"
            | "latin1"
            | "hex"
            | "buffer";
        maxQueue?: number;
        overflow?: "ignore"
        | "throw";
        persistent?: boolean;
        recursive?: boolean;
        signal?: AbortSignal;
    }

    Hierarchy (View Summary)

    Index

    Properties

    encoding? maxQueue? overflow? persistent? recursive? signal?

    Properties

    encoding?:
        | "base64"
        | "binary"
        | "ascii"
        | "utf8"
        | "utf-8"
        | "utf16le"
        | "utf-16le"
        | "ucs2"
        | "ucs-2"
        | "base64url"
        | "latin1"
        | "hex"
        | "buffer"
    maxQueue?: number

    Specifies the number of events to queue between iterations of the AsyncIterator. Default: 2048.

    overflow?: "ignore" | "throw"

    Either 'ignore' or 'throw' when there are more events to be queued than maxQueue allows. 'ignore' means overflow events are dropped and a warning is emitted, while 'throw' means to throw an exception. Default: 'ignore'.

    persistent?: boolean

    Indicates whether the process should continue to run as long as files are being watched. Default: true.

    recursive?: boolean

    Indicates whether all subdirectories should be watched, or only the current directory. This applies when a directory is specified, and only on supported platforms (See caveats). Default: false.

    signal?: AbortSignal

    Allows closing the watcher with an AbortSignal.

    Settings

    Member Visibility

    On This Page

    Properties