Installation

npm install --save @types/fb-watchman

Summary

This package contains type definitions for fb-watchman (https://facebook.github.io/watchman/).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/fb-watchman.

index.d.ts

// Type definitions for fb-watchman 2.0
// Project: https://facebook.github.io/watchman/
// Definitions by: Wu Haotian <https://github.com/whtsky>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

import { EventEmitter } from 'events';

// Emit the responses to these when they get sent down to us
export type UnilateralTags = 'unilateralTags' | 'log';

export interface ClientOptions {
  /**
   * Absolute path to the watchman binary.
   * If not provided, the Client locates the binary using the PATH specified
   * by the node child_process's default env.
   */
  watchmanBinaryPath?: string | undefined;
}

export interface Capabilities {
  optional: any[];
  required: any[];
}

export type doneCallback = (error?: Error | null, resp?: any) => any;

export class Client extends EventEmitter {
  constructor(options?: ClientOptions)
  sendNextCommand(): void;
  cancelCommands(why: string): void;
  connect(): void;
  command(args: any, done: doneCallback): void;
  capabilityCheck(
    caps: Capabilities,
    done: doneCallback,
  ): void;
  end(): void;
}

Additional Details

Last updated: Tue, 06 Jul 2021 20:32:53 GMT
Dependencies: none
Global values: none

Credits

These definitions were written by Wu Haotian.

Current Tags

2 Versions

2.0.1 ... 5 years ago
2.0.0 ... 8 years ago