DefinitelyTyped/types/pathwatcher/README.md
Glen M dad4c42dd7 Update the Atom type definitions. (#20146)
* Update the Atom type definitions.

* Atom: support additional dtslint rules. Minor fixes to definitions.

* Atom: enable unified signatures for dtslint.

* Atom: fix the scan and replace functions. Enable ban-types in dtslint.

* Atom: enable no-declare-current-package and no-single-declare-module.
2017-10-02 10:41:57 -07:00

816 B

Path Watcher Node Type Definitions

TypeScript type definitions for [Path Watcher Node], which is published as "pathwatcher" on NPM.

Usage Notes

Exports

The two classes exported from this module are: File and Directory.

import { File, Directory } from "text-buffer";

Additionally, the following functions are exported as well:

watch(): PathWatcher.PathWatcher;
closeAllWatchers(): void;
getWatchedPaths(): string[];

The PathWatcher Namespace

All types used by Path Watcher can be referenced from the PathWatcher namespace.

function example(file: PathWatcher.File) {}