Logo for jsDocs.io

@types/gaze

  • Version 1.1.5
  • Published
  • 5.99 kB
  • No dependencies
  • MIT license

Install

npm i @types/gaze
yarn add @types/gaze
pnpm add @types/gaze

Overview

TypeScript definitions for gaze

Index

Functions

Classes

Functions

function gaze

gaze: typeof gaze;

    Classes

    class Gaze

    class Gaze {}

      constructor

      constructor(
          patterns: string | string[],
          options?: Options,
          callback?: (error: Error | null, watcher: Gaze) => void
      );

        method add

        add: (patterns: string | string[]) => void;

        • Adds file(s) patterns to be watched.

        method close

        close: () => void;

        • Unwatch all files and reset the watch instance.

        method emit

        emit: (event: string, ...args: any) => boolean;

        • Wrapper for EventEmitter.emit. added|changed|renamed|deleted events will also trigger the all event.

        method relative

        relative: (dir: string, unixify: boolean) => string[];

        • Returns the currently watched files with relative paths.

        method remove

        remove: (filepath: string) => void;

        • Removes a file or directory from being watched. Does not recurse directories.

        method watched

        watched: () => string[];

        • Returns the currently watched files.

        Package Files (1)

        Dependencies (0)

        No dependencies.

        Dev Dependencies (0)

        No dev dependencies.

        Peer Dependencies (0)

        No peer dependencies.

        Badge

        To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

        You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/gaze.

        • Markdown
          [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/gaze)
        • HTML
          <a href="https://www.jsdocs.io/package/@types/gaze"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>