@types/chokidar - npm Package Compare versions

Comparing version 1.4.31 to 1.6.0

chokidar/index.d.ts

@@ -1,4 +0,4 @@
-// Type definitions for chokidar 1.4.3
+// Type definitions for chokidar 1.6.1
 // Project: https://github.com/paulmillr/chokidar
-// Definitions by: Stefan Steinhart <https://github.com/reppners/>
+// Definitions by: Stefan Steinhart <https://github.com/reppners/>, Felix Becker <https://github.com/felixfbecker/>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -8,43 +8,154 @@
 
-declare module "chokidar"
-{
-    export class FSWatcher
-    {
-        constructor(options?: WatchOptions);
-        add(fileDirOrGlob:string):void;
-        add(filesDirsOrGlobs:Array<string>):void;
-        unwatch(fileDirOrGlob:string):void;
-        unwatch(filesDirsOrGlobs:Array<string>):void;
-        getWatched():any;
-        on(event: 'add', fn: (path: string, stats?: fs.Stats) => void): this;
-        on(event: 'change', fn: (path: string, stats?: fs.Stats) => void): this;
-        on(event: 'unlink', fn: (path: string) => void): this;
-        on(event: 'raw', fn: (event: string, path:string, details:any) => void): this;
-        on(event: 'all', fn: (event: string, path: string) => void): this;
-        on(event: string, fn: (path: string) => void): this;
-        close(): this;
-    }
+import * as fs from 'fs';
+import {EventEmitter} from 'events';
 
-    interface WatchOptions
-    {
-        persistent?:boolean;
-        ignored?:any;
-        ignoreInitial?:boolean;
-        followSymlinks?:boolean;
-        cwd?:string;
-        usePolling?:boolean;
-        useFsEvents?:boolean;
-        alwaysStat?:boolean;
-        depth?:number;
-        interval?:number;
-        binaryInterval?:number;
-        ignorePermissionErrors?:boolean;
-        atomic?:boolean;
-        awaitWriteFinish?:any;
-    }
+/**
+ * The object's keys are all the directories (using absolute paths unless the `cwd` option was
+ * used), and the values are arrays of the names of the items contained in each directory.
+ */
+export interface WatchedPaths {
+    [directory: string]: string[];
+}
 
-    import fs = require("fs");
+export class FSWatcher extends EventEmitter implements fs.FSWatcher {
 
-    export function watch(fileDirOrGlob:string, options?:WatchOptions):FSWatcher;
-    export function watch(filesDirsOrGlobs:Array<string>, options?:WatchOptions):FSWatcher;
+    /**
+     * Add files, directories, or glob patterns for tracking. Takes an array of strings or just one
+     * string.
+     */
+    add(paths: string | string[]): void;
+
+    /**
+     * Stop watching files, directories, or glob patterns. Takes an array of strings or just one
+     * string.
+     */
+    unwatch(paths: string | string[]): void;
+
+    /**
+     * Returns an object representing all the paths on the file system being watched by this
+     * `FSWatcher` instance. The object's keys are all the directories (using absolute paths unless
+     * the `cwd` option was used), and the values are arrays of the names of the items contained in
+     * each directory.
+     */
+    getWatched(): WatchedPaths;
+
+    /**
+     * Removes all listeners from watched files.
+     */
+    close(): void;
 }
+
+export interface WatchOptions {
+
+    /**
+     * Indicates whether the process should continue to run as long as files are being watched. If
+     * set to `false` when using `fsevents` to watch, no more events will be emitted after `ready`,
+     * even if the process continues to run.
+     */
+    persistent?: boolean;
+
+    /**
+     * ([anymatch](https://github.com/es128/anymatch)-compatible definition) Defines files/paths to
+     * be ignored. The whole relative or absolute path is tested, not just filename. If a function
+     * with two arguments is provided, it gets called twice per path - once with a single argument
+     * (the path), second time with two arguments (the path and the
+     * [`fs.Stats`](http://nodejs.org/api/fs.html#fs_class_fs_stats) object of that path).
+     */
+    ignored?: any;
+
+    /**
+     * If set to `false` then `add`/`addDir` events are also emitted for matching paths while
+     * instantiating the watching as chokidar discovers these file paths (before the `ready` event).
+     */
+    ignoreInitial?: boolean;
+
+    /**
+     * When `false`, only the symlinks themselves will be watched for changes instead of following
+     * the link references and bubbling events through the link's path.
+     */
+    followSymlinks?: boolean;
+
+    /**
+     * The base directory from which watch `paths` are to be derived. Paths emitted with events will
+     * be relative to this.
+     */
+    cwd?: string;
+
+    /**
+     * Whether to use fs.watchFile (backed by polling), or fs.watch. If polling leads to high CPU
+     * utilization, consider setting this to `false`. It is typically necessary to **set this to
+     * `true` to successfully watch files over a network**, and it may be necessary to successfully
+     * watch files in other non-standard situations. Setting to `true` explicitly on OS X overrides
+     * the `useFsEvents` default.
+     */
+    usePolling?: boolean;
+
+    /**
+     * Whether to use the `fsevents` watching interface if available. When set to `true` explicitly
+     * and `fsevents` is available this supercedes the `usePolling` setting. When set to `false` on
+     * OS X, `usePolling: true` becomes the default.
+     */
+    useFsEvents?: boolean;
+
+    /**
+     * If relying upon the [`fs.Stats`](http://nodejs.org/api/fs.html#fs_class_fs_stats) object that
+     * may get passed with `add`, `addDir`, and `change` events, set this to `true` to ensure it is
+     * provided even in cases where it wasn't already available from the underlying watch events.
+     */
+    alwaysStat?: boolean;
+
+    /**
+     * If set, limits how many levels of subdirectories will be traversed.
+     */
+    depth?: number;
+
+    /**
+     * Interval of file system polling.
+     */
+    interval?: number;
+
+    /**
+     * Interval of file system polling for binary files. ([see list of binary extensions](https://gi
+     * thub.com/sindresorhus/binary-extensions/blob/master/binary-extensions.json))
+     */
+    binaryInterval?: number;
+
+    /**
+     *  Indicates whether to watch files that don't have read permissions if possible. If watching
+     *  fails due to `EPERM` or `EACCES` with this set to `true`, the errors will be suppressed
+     *  silently.
+     */
+    ignorePermissionErrors?: boolean;
+
+    /**
+     * `true` if `useFsEvents` and `usePolling` are `false`). Automatically filters out artifacts
+     * that occur when using editors that use "atomic writes" instead of writing directly to the
+     * source file. If a file is re-added within 100 ms of being deleted, Chokidar emits a `change`
+     * event rather than `unlink` then `add`. If the default of 100 ms does not work well for you,
+     * you can override it by setting `atomic` to a custom value, in milliseconds.
+     */
+    atomic?: boolean | number;
+
+    /**
+     * can be set to an object in order to adjust timing params:
+     */
+    awaitWriteFinish?: AwaitWriteFinishOptions;
+}
+
+export interface AwaitWriteFinishOptions {
+
+    /**
+     * Amount of time in milliseconds for a file size to remain constant before emitting its event.
+     */
+    stabilityThreshold?: number;
+
+    /**
+     * File size polling interval.
+     */
+    pollInterval?: number;
+}
+
+/**
+ * produces an instance of `FSWatcher`.
+ */
+export function watch(paths: string | string[], options?: WatchOptions): FSWatcher;

chokidar/package.json

 {
     "name": "@types/chokidar",
-    "version": "1.4.31",
+    "version": "1.6.0",
     "description": "TypeScript definitions for chokidar",
     "license": "MIT",
-    "author": "Stefan Steinhart <https://github.com/reppners/>",
+    "contributors": [
+        {
+            "name": "Stefan Steinhart",
+            "url": "https://github.com/reppners/"
+        },
+        {
+            "name": "Felix Becker",
+            "url": "https://github.com/felixfbecker/"
+        }
+    ],
     "main": "",
@@ -17,4 +26,4 @@ "repository": {
     "peerDependencies": {},
-    "typesPublisherContentHash": "46df44f97fbabd657bde4974c49d483b0be1b70bdeea3d45247e6f2aba77ccb3",
+    "typesPublisherContentHash": "742cc5302d05eff1d7ccae30c443a0cd41c9629312b892607b42c91e5ec55c2e",
     "typeScriptVersion": "2.0"
 }

chokidar/README.md

@@ -11,8 +11,7 @@ # Installation
 Additional Details
- * Last updated: Mon, 02 Jan 2017 22:24:30 GMT
- * Library Dependencies: node
- * Module Dependencies: fs
+ * Last updated: Thu, 23 Mar 2017 21:42:46 GMT
+ * Dependencies: fs, events, node
  * Global values: none
 
 # Credits
-These definitions were written by Stefan Steinhart <https://github.com/reppners/>.
+These definitions were written by Stefan Steinhart <https://github.com/reppners/>, Felix Becker <https://github.com/felixfbecker/>.

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

7283

increased by103.1%

Lines of code

133

increased by92.75%

Worsened metrics

Number of package files

3

decreased by-25%

Number of lines in readme file

17

decreased by-5.56%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes