Module jake

Index

Variables

Interfaces

Classes

Functions

Variables

logger: Logger

program: { opts: { quiet: boolean; [name: string]: any; }; taskNames: string[]; taskArgs: string[]; envVars: { [key: string]: string; }; }

(): string

Returns

string

(): any

Returns

any

public opts.quiet: boolean

public program.envVars: { [key: string]: string; }

public program.opts: { quiet: boolean; [name: string]: any; }

public program.taskArgs: Array<string>

public program.taskNames: Array<string>

Functions

addListener(event: string, listener: Function): EventEmitter

Parameters

  • event: string
  • listener: Function

Returns

EventEmitter

cpR(path: string, destination: string, opts?: UtilOptions, callback?: () => void)

The jake.cpR utility does a recursive copy of a file or directory. Note that this command can only copy files and directories; it does not perform globbing (so arguments like '*.txt' are not possible).

Parameters

  • path: string

    the file/directory to copy,

  • destination: string

    the destination.

  • opts?: UtilOptions optional
  • callback?: () => void optional

cpR(path: string, destination: string, callback?: (err: Error) => void)

Parameters

  • path: string
  • destination: string
  • callback?: (err: Error) => void optional

createExec(cmds: Array<string>, callback?: () => void, opts?: ExecOptions): Exec

Parameters

  • cmds: Array<string>
  • callback?: () => void optional
  • opts?: ExecOptions optional

Returns

Exec

createExec(cmds: Array<string>, opts?: ExecOptions, callback?: () => void): Exec

Parameters

  • cmds: Array<string>
  • opts?: ExecOptions optional
  • callback?: () => void optional

Returns

Exec

createExec(cmds: string, callback?: () => void, opts?: ExecOptions): Exec

Parameters

  • cmds: string
  • callback?: () => void optional
  • opts?: ExecOptions optional

Returns

Exec

createExec(cmds: string, opts?: ExecOptions, callback?: () => void): Exec

Parameters

  • cmds: string
  • opts?: ExecOptions optional
  • callback?: () => void optional

Returns

Exec

emit(event: string, args?: Array<any>): boolean

Parameters

  • event: string
  • args?: Array<any> optional

Returns

boolean

exec(cmds: Array<string>, callback?: () => void, opts?: ExecOptions)

Parameters

  • cmds: Array<string>
  • callback?: () => void optional
  • opts?: ExecOptions optional

listeners(event: string): Array<Function>

Parameters

  • event: string

Returns

Array<Function>

mkdirP(name: string, mode?: string, f?: (er: Error, made: any) => void)

The jake.mkdirP utility recursively creates a set of nested directories. It will not throw an error if any of the directories already exists. https://github.com/substack/node-mkdirp

Parameters

  • name: string
  • mode?: string optional
  • f?: (er: Error, made: any) => void optional

mkdirP(name: string, f?: (er: Error, made: any) => void)

Parameters

  • name: string
  • f?: (er: Error, made: any) => void optional

on(event: string, listener: Function): EventEmitter

Parameters

  • event: string
  • listener: Function

Returns

EventEmitter

once(event: string, listener: Function): EventEmitter

Parameters

  • event: string
  • listener: Function

Returns

EventEmitter

readdirR(name: string, opts?: UtilOptions): Array<string>

The jake.readdirR utility gives you a recursive directory listing, giving you output somewhat similar to the Unix find command. It only works with a directory name, and does not perform filtering or globbing.

Parameters

Returns

Array<string>

an array of filepaths for all files in the 'pkg' directory, and all its subdirectories.

removeAllListener(event: string): EventEmitter

Parameters

  • event: string

Returns

EventEmitter

removeListener(event: string, listener: Function): EventEmitter

Parameters

  • event: string
  • listener: Function

Returns

EventEmitter

rmRf(name: string, opts?: UtilOptions)

The jake.rmRf utility recursively removes a directory and all its contents.

Parameters

setMaxListeners(n: number)

Parameters

  • n: number