foy

Index

Namespaces

Enumerations

TaskState

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

Callback

Callback: { fn: (args?: any) => void | Promise<void>; namespaces: string[] }

Type declaration

fn: (args?: any) => void | Promise<void>
- - (args?: any): void | Promise<void>
  - Parameters
    - Optional args: any
    Returns void | Promise<void>
namespaces: string[]

Dependency

Dependency: TaskDep | string | DepBuilder

ListenerNames

ListenerNames: "before" | "after" | "onerror"

LogLevels

LogLevels: keyof typeof LogLevels

OptionDef

OptionDef: [string, string, OptionConfig | undefined]

TaskFn

TaskFn<O, T>: (ctx: TaskContext<O>) => T | Promise<T>

Type parameters

O
T = any

Type declaration

- (ctx: TaskContext<O>): T | Promise<T>
- Parameters
  - ctx: TaskContext<O>
  Returns T | Promise<T>

WatchDirHandler

WatchDirHandler: (event: string, filename: string) => void

Type declaration

- (event: string, filename: string): void
- Parameters
  - event: string
  - filename: string
  Returns void

WatchDirOptions

WatchDirOptions: { persistent?: undefined | false | true; threshold?: undefined | number }

Type declaration

Optional persistent?: undefined | false | true
Optional threshold?: undefined | number

ms, default 300

Variables

Const DefaultLogFile

DefaultLogFile: string = join(process.cwd(), 'foy.log')

Const EEXIST

EEXIST: "EEXIST" = "EEXIST"

Const ENOENT

ENOENT: "ENOENT" = "ENOENT"

Const TMKey

TMKey: string = `@foy${require('../package.json').version}/taskManager`

Const fs

fs: "fs" & "fs/promises" & { copy: copy; copyFile: __promisify__ | (Anonymous function); watchDir: watchDir; exists: any; isDirectory: any; isFile: any; isSymbolicLink: any; iter: any; lexists: any; mkdirp: any; mkdirpSync: any; outputFile: any; outputFileSync: any; outputJson: any; outputJsonSync: any; readJson: any; readJsonSync: any; rmrf: any } = Object.assign({}, _fs, _fs.promises, fsExtra)

Const logger

logger: Logger = new Logger()

Let objUid

objUid: number = 0

Let objUidMap

objUidMap: WeakMap<object, number> = new WeakMap<object, number>()

Const shellParser

shellParser: any = require('shell-parser')

Const spawn

spawn: { command: any; commandSync: any; node: any; sync: any } = execa

Type declaration

- (file: string, arguments?: readonly string[], options?: execa.Options): execa.ExecaChildProcess
- (file: string, arguments?: readonly string[], options?: execa.Options<null>): execa.ExecaChildProcess<Buffer>
- (file: string, options?: execa.Options): execa.ExecaChildProcess
- (file: string, options?: execa.Options<null>): execa.ExecaChildProcess<Buffer>
- Execute a file.
  
  Think of this as a mix of child_process.execFile and child_process.spawn.
  example
  import execa = require('execa'); (async () => { const {stdout} = await execa('echo', ['unicorns']); console.log(stdout); //=> 'unicorns' // Cancelling a spawned process const subprocess = execa('node'); setTimeout(() => { spawned.cancel() }, 1000); try { await subprocess; } catch (error) { console.log(subprocess.killed); // true console.log(error.isCanceled); // true } })(); // Pipe the child process stdout to the current stdout execa('echo', ['unicorns']).stdout.pipe(process.stdout);
  Parameters
  - file: string
    
    The program/script to execute.
  - Optional arguments: readonly string[]
    
    Arguments to pass to file on execution.
  - Optional options: execa.Options
  Returns execa.ExecaChildProcess
  
  A child_process instance, which is enhanced to also be a Promise for a result Object with stdout and stderr properties.
- Parameters
  - file: string
  - Optional arguments: readonly string[]
  - Optional options: execa.Options<null>
  Returns execa.ExecaChildProcess<Buffer>
- Parameters
  - file: string
  - Optional options: execa.Options
  Returns execa.ExecaChildProcess
- Parameters
  - file: string
  - Optional options: execa.Options<null>
  Returns execa.ExecaChildProcess<Buffer>
command: function
- command(command: string, options?: execa.Options): execa.ExecaChildProcess
- command(command: string, options?: execa.Options<null>): execa.ExecaChildProcess<Buffer>
- - Defined in node_modules/execa/index.d.ts:511
  Same as execa() except both file and arguments are specified in a single command string. For example, execa('echo', ['unicorns']) is the same as execa.command('echo unicorns').
  
  If the file or an argument contains spaces, they must be escaped with backslashes. This matters especially if command is not a constant but a variable, for example with __dirname or process.cwd(). Except for spaces, no escaping/quoting is needed.
  
  The shell option must be used if the command uses shell-specific features, as opposed to being a simple file followed by its arguments.
  example
  import execa = require('execa'); (async () => { const {stdout} = await execa.command('echo unicorns'); console.log(stdout); //=> 'unicorns' })();
  Parameters
  - command: string
    
    The program/script to execute and its arguments.
  - Optional options: execa.Options
  Returns execa.ExecaChildProcess
  
  A child_process instance, which is enhanced to also be a Promise for a result Object with stdout and stderr properties.
- - Defined in node_modules/execa/index.d.ts:512
  Parameters
  - command: string
  - Optional options: execa.Options<null>
  Returns execa.ExecaChildProcess<Buffer>
commandSync: function
- commandSync(command: string, options?: execa.SyncOptions): ExecaSyncReturnValue
- commandSync(command: string, options?: execa.SyncOptions<null>): ExecaSyncReturnValue<Buffer>
- - Defined in node_modules/execa/index.d.ts:520
  Same as execa.command() but synchronous.
  
  Parameters
  - command: string
    
    The program/script to execute and its arguments.
  - Optional options: execa.SyncOptions
  Returns ExecaSyncReturnValue
  
  A result Object with stdout and stderr properties.
- - Defined in node_modules/execa/index.d.ts:521
  Parameters
  - command: string
  - Optional options: execa.SyncOptions<null>
  Returns ExecaSyncReturnValue<Buffer>
node: function
- node(scriptPath: string, arguments?: readonly string[], options?: execa.NodeOptions): execa.ExecaChildProcess
- node(scriptPath: string, arguments?: readonly string[], options?: execa.Options<null>): execa.ExecaChildProcess<Buffer>
- node(scriptPath: string, options?: execa.Options): execa.ExecaChildProcess
- node(scriptPath: string, options?: execa.Options<null>): execa.ExecaChildProcess<Buffer>
- - Defined in node_modules/execa/index.d.ts:535
  Execute a Node.js script as a child process.
  
  Same as execa('node', [scriptPath, ...arguments], options) except (like child_process#fork()):
  - the current Node version and options are used. This can be overridden using the nodePath and nodeArguments options.
  - the shell option cannot be used
  - an extra channel ipc is passed to stdio
  Parameters
  - scriptPath: string
    
    Node.js script to execute.
  - Optional arguments: readonly string[]
    
    Arguments to pass to scriptPath on execution.
  - Optional options: execa.NodeOptions
  Returns execa.ExecaChildProcess
  
  A child_process instance, which is enhanced to also be a Promise for a result Object with stdout and stderr properties.
- - Defined in node_modules/execa/index.d.ts:540
  Parameters
  - scriptPath: string
  - Optional arguments: readonly string[]
  - Optional options: execa.Options<null>
  Returns execa.ExecaChildProcess<Buffer>
- - Defined in node_modules/execa/index.d.ts:545
  Parameters
  - scriptPath: string
  - Optional options: execa.Options
  Returns execa.ExecaChildProcess
- - Defined in node_modules/execa/index.d.ts:546
  Parameters
  - scriptPath: string
  - Optional options: execa.Options<null>
  Returns execa.ExecaChildProcess<Buffer>
sync: function
- sync(file: string, arguments?: readonly string[], options?: execa.SyncOptions): ExecaSyncReturnValue
- sync(file: string, arguments?: readonly string[], options?: execa.SyncOptions<null>): ExecaSyncReturnValue<Buffer>
- sync(file: string, options?: execa.SyncOptions): ExecaSyncReturnValue
- sync(file: string, options?: execa.SyncOptions<null>): ExecaSyncReturnValue<Buffer>
- - Defined in node_modules/execa/index.d.ts:474
  Execute a file synchronously.
  
  This method throws an Error if the command fails.
  
  Parameters
  - file: string
    
    The program/script to execute.
  - Optional arguments: readonly string[]
    
    Arguments to pass to file on execution.
  - Optional options: execa.SyncOptions
  Returns ExecaSyncReturnValue
  
  A result Object with stdout and stderr properties.
- - Defined in node_modules/execa/index.d.ts:479
  Parameters
  - file: string
  - Optional arguments: readonly string[]
  - Optional options: execa.SyncOptions<null>
  Returns ExecaSyncReturnValue<Buffer>
- - Defined in node_modules/execa/index.d.ts:484
  Parameters
  - file: string
  - Optional options: execa.SyncOptions
  Returns ExecaSyncReturnValue
- - Defined in node_modules/execa/index.d.ts:485
  Parameters
  - file: string
  - Optional options: execa.SyncOptions<null>
  Returns ExecaSyncReturnValue<Buffer>

Functions

_exec

_exec(cmd: string, options?: execa.Options): ExecaChildProcess<string>

- Defined in src/exec.ts:11
Parameters
- cmd: string
- Optional options: execa.Options
Returns ExecaChildProcess<string>

Const after

after(fn: (t: Task) => void | Promise<void>): void

- Defined in src/task.ts:82
Parameters
- fn: (t: Task) => void | Promise<void>
  - - (t: Task): void | Promise<void>
    - Parameters
      - t: Task
      Returns void | Promise<void>
Returns void

appendCallback

appendCallback<Fn>(name: ListenerNames, fn: Fn): void

- Defined in src/task.ts:74
Type parameters
- Fn: (...args: any[]) => void | Promise<void>
Parameters
- name: ListenerNames
- fn: Fn
Returns void

Const before

before(fn: (t: Task) => void | Promise<void>): void

- Defined in src/task.ts:81
Parameters
- fn: (t: Task) => void | Promise<void>
  - - (t: Task): void | Promise<void>
    - Parameters
      - t: Task
      Returns void | Promise<void>
Returns void

copy

copy(src: string, dist: string, opts?: undefined | { overwrite?: undefined | false | true; skip?: undefined | ((file: string, stat: Stats) => Promise<boolean | void> | boolean | void) }): Promise<void>

- Defined in src/fs.ts:17
Parameters
- src: string
- dist: string
- Optional opts: undefined | { overwrite?: undefined | false | true; skip?: undefined | ((file: string, stat: Stats) => Promise<boolean | void> | boolean | void) }
Returns Promise<void>

debounce

debounce<T>(cb: T, ms: number, getArgsKey?: (args: any[]) => string): T

- Defined in src/utils.ts:50
Type parameters
- T: (...args: any[]) => void
Parameters
- cb: T
- ms: number
- Default value getArgsKey: (args: any[]) => string = (args: any[]) => args.join('|')
  - - (args: any[]): string
    - Parameters
      - args: any[]
      Returns string
Returns T

defaults

defaults<T>(val: T | undefined, defaultVal: T): T
defaults<T>(val: T | undefined, val1: T | undefined, defaultVal: T): T
defaults<T>(val: T | undefined, val1: T | undefined, val2: T | undefined, defaultVal: T): T
defaults<T>(val: T | undefined, val1: T | undefined, val2: T | undefined, val3: T | undefined, defaultVal: T): T
defaults<T>(val: T | undefined, val1: T | undefined, val2: T | undefined, val3: T | undefined, val4: T | undefined, defaultVal: T): T

- Defined in src/utils.ts:98
Type parameters
- T
Parameters
- val: T | undefined
- defaultVal: T
Returns T
- Defined in src/utils.ts:99
Type parameters
- T
Parameters
- val: T | undefined
- val1: T | undefined
- defaultVal: T
Returns T
- Defined in src/utils.ts:100
Type parameters
- T
Parameters
- val: T | undefined
- val1: T | undefined
- val2: T | undefined
- defaultVal: T
Returns T
- Defined in src/utils.ts:106
Type parameters
- T
Parameters
- val: T | undefined
- val1: T | undefined
- val2: T | undefined
- val3: T | undefined
- defaultVal: T
Returns T
- Defined in src/utils.ts:113
Type parameters
- T
Parameters
- val: T | undefined
- val1: T | undefined
- val2: T | undefined
- val3: T | undefined
- val4: T | undefined
- defaultVal: T
Returns T

dep

dep(dep: Dependency): DepBuilder<any>

- Defined in src/dep-builder.ts:45
Parameters
- dep: Dependency
Returns DepBuilder<any>

desc

desc(desc: string): void

- Defined in src/task.ts:101
Define task description

Parameters
- desc: string
Returns void

exec

exec(command: string, options?: execa.Options): execa.ExecaChildProcess
exec(commands: string[], options?: execa.Options): Promise<ExecaSyncReturnValue<string>[]>

- Defined in src/exec.ts:15
Parameters
- command: string
- Optional options: execa.Options
Returns execa.ExecaChildProcess
- Defined in src/exec.ts:16
Parameters
- commands: string[]
- Optional options: execa.Options
Returns Promise<ExecaSyncReturnValue<string>[]>

Const formatDate

formatDate(d: Date): string

- Defined in src/utils.ts:132
Parameters
- d: Date
Returns string

formatDuration

formatDuration(ms: number): string

- Defined in src/utils.ts:137
Parameters
- ms: number
Returns string

makeLogger

makeLogger(level: LogLevels, logger: Logger): (Anonymous function)

- Defined in src/logger.ts:13
Parameters
- level: LogLevels
- logger: Logger
Returns (Anonymous function)

namespace

namespace(ns: string, fn: (ns: string) => void): void

- Defined in src/task.ts:193
Create namespace prefix for inner tasks

example

namespace('client', ns => { task('run', async ctx => { logger.log(ns) // 'client' await ctx.exec('') }) }) namespace('server', ns => { task('run', async ctx => { logger.log(ns) // 'server' await ctx.exec('') }) })

========== $ yarn foy client:run $ yarn foy server:run

Parameters
- ns: string
  
  namespace
- fn: (ns: string) => void
  - - (ns: string): void
    - Parameters
      - ns: string
      Returns void
Returns void

Const onerror

onerror(fn: (err: Error, t: Task) => void | Promise<void>): void

- Defined in src/task.ts:83
Parameters
- fn: (err: Error, t: Task) => void | Promise<void>
  - - (err: Error, t: Task): void | Promise<void>
    - Parameters
      - err: Error
      - t: Task
      Returns void | Promise<void>
Returns void

option

option(rawName: string, description: string, config?: OptionConfig): void

- Defined in src/task.ts:110
Define a task cli option

Parameters
- rawName: string
- description: string
- Optional config: OptionConfig
Returns void

promiseQueue

promiseQueue<A, R>(cb: (...args: A) => Promise<R> | R): (Anonymous function)

- Defined in src/utils.ts:69
Type parameters
- A: any[]
- R
Parameters
- cb: (...args: A) => Promise<R> | R
  - - (...args: A): Promise<R> | R
    - Parameters
      - Rest ...args: A
      Returns Promise<R> | R
Returns (Anonymous function)

setGlobalOptions

setGlobalOptions(options: GlobalOptions): void

- Defined in src/task.ts:71
Set global options for all tasks.

Parameters
- options: GlobalOptions
Returns void

setOption

setOption(options: Partial<typeof last>): void

- Defined in src/task.ts:123
Set options for next task.

Parameters
- options: Partial<typeof last>
Returns void

shell

shell(callback: (ctx: ShellContext) => Promise<any>): Promise<any>

- Defined in src/exec.ts:235
Parameters
- callback: (ctx: ShellContext) => Promise<any>
  - - (ctx: ShellContext): Promise<any>
    - Parameters
      - ctx: ShellContext
      Returns Promise<any>
Returns Promise<any>

Const sleep

sleep(ms: number): Promise<void>

- Defined in src/utils.ts:46
Parameters
- ms: number
Returns Promise<void>

strict

strict(): void

- Defined in src/task.ts:116
Define task cli options are strict, which means it will throw an error if you passed undefined options.

Returns void

task

task<O>(name: string, fn: TaskFn<O>): Task<O>
task<O>(name: string, dependencies: Dependency[], fn?: TaskFn<O>): Task<O>

- Defined in src/task.ts:126
Define a task

Type parameters
- O
Parameters
- name: string
- fn: TaskFn<O>
Returns Task<O>
- Defined in src/task.ts:127
Define a task

Type parameters
- O
Parameters
- name: string
- dependencies: Dependency[]
- Optional fn: TaskFn<O>
Returns Task<O>

watchDir

watchDir(dir: string, cb: WatchDirHandler): void
watchDir(dir: string, options: WatchDirOptions, cb: WatchDirHandler): void

- Defined in src/fs.ts:72
Parameters
- dir: string
- cb: WatchDirHandler
Returns void
- Defined in src/fs.ts:73
Parameters
- dir: string
- options: WatchDirOptions
- cb: WatchDirHandler
Returns void

Object literals

Const Is

Is: object

bool

bool(v: any): v is boolean

- Defined in src/utils.ts:84
Parameters
- v: any
Returns v is boolean

defed

defed<T>(v: T | null | undefined): v is T

- Defined in src/utils.ts:78
Type parameters
- T
Parameters
- v: T | null | undefined
Returns v is T

fn

fn(v: any): v is Function

- Defined in src/utils.ts:87
Parameters
- v: any
Returns v is Function

num

num(v: any): v is number

- Defined in src/utils.ts:93
Parameters
- v: any
Returns v is number

obj

obj(v: any): v is object

- Defined in src/utils.ts:90
Parameters
- v: any
Returns v is object

str

str(v: any): v is string

- Defined in src/utils.ts:81
Parameters
- v: any
Returns v is string

Const LogLevels

LogLevels: object

debug

debug: number = 0

error

error: number = 3

info

info: number = 1

warn

warn: number = 2

Const fsExtra

fsExtra: object

copy

copy: copy

copyFile

copyFile: __promisify__ | (Anonymous function) = _fs.copyFile? util.promisify(_fs.copyFile): async (src: _fs.PathLike, dist: _fs.PathLike) => {await _fs.promises.stat(src)return new Promise((res, rej) => {_fs.createReadStream(src, { highWaterMark: 2 * 1024 * 1024 }).pipe(_fs.createWriteStream(dist)).on('error', rej).on('close', res)})}

watchDir

watchDir: watchDir

exists

exists(path: _fs.PathLike): Promise<boolean>

- Defined in src/fs.ts:112
Parameters
- path: _fs.PathLike
Returns Promise<boolean>

isDirectory

isDirectory(path: _fs.PathLike): Promise<boolean>

- Defined in src/fs.ts:148
Parameters
- path: _fs.PathLike
Returns Promise<boolean>

isFile

isFile(path: _fs.PathLike): Promise<boolean>

- Defined in src/fs.ts:137
Parameters
- path: _fs.PathLike
Returns Promise<boolean>

isSymbolicLink

isSymbolicLink(path: _fs.PathLike): Promise<boolean>

- Defined in src/fs.ts:159
Parameters
- path: _fs.PathLike
Returns Promise<boolean>

iter

iter(dir: string, skip: (path: string, stat: Stats) => Promise<boolean | void> | boolean | void): Promise<void>

- Defined in src/fs.ts:285
Parameters
- dir: string
- skip: (path: string, stat: Stats) => Promise<boolean | void> | boolean | void
  - - (path: string, stat: Stats): Promise<boolean | void> | boolean | void
    - Parameters
      - path: string
      - stat: Stats
      Returns Promise<boolean | void> | boolean | void
Returns Promise<void>

lexists

lexists(path: _fs.PathLike): Promise<boolean>

- Defined in src/fs.ts:125
exists via lstat, if a symbolic link's target file doesn't exists, fs.exists will return false, but fs.lexists will return true.

Parameters
- path: _fs.PathLike
Returns Promise<boolean>

mkdirp

mkdirp(dir: string): Promise<void>

- Defined in src/fs.ts:185
Make directory with parents, like mkdir -p

Parameters
- dir: string
Returns Promise<void>

mkdirpSync

mkdirpSync(dir: string): void

- Defined in src/fs.ts:200
Make directory with parents, like mkdir -p

Parameters
- dir: string
Returns void

outputFile

outputFile(path: string, data: any, options?: WriteOptions): Promise<void>

- Defined in src/fs.ts:239
Parameters
- path: string
- data: any
- Optional options: WriteOptions
Returns Promise<void>

outputFileSync

outputFileSync(path: string, data: any, options?: WriteOptions): void

- Defined in src/fs.ts:244
Parameters
- path: string
- data: any
- Optional options: WriteOptions
Returns void

outputJson

outputJson(path: string, data: object, options?: { replacer?: undefined | ((key: string, value: any) => any); space?: undefined | number } & WriteOptions): Promise<void>

- Defined in src/fs.ts:249
Parameters
- path: string
- data: object
- Optional options: { replacer?: undefined | ((key: string, value: any) => any); space?: undefined | number } & WriteOptions
Returns Promise<void>

outputJsonSync

outputJsonSync(path: string, data: any, options?: { replacer?: undefined | ((key: string, value: any) => any); space?: undefined | number } & WriteOptions): void

- Defined in src/fs.ts:260
Parameters
- path: string
- data: any
- Optional options: { replacer?: undefined | ((key: string, value: any) => any); space?: undefined | number } & WriteOptions
Returns void

readJson

readJson<T>(path: string, options?: { encoding?: undefined | null; flag?: undefined | string } | null): Promise<T>

- Defined in src/fs.ts:271
Type parameters
- T = any
Parameters
- path: string
- Optional options: { encoding?: undefined | null; flag?: undefined | string } | null
Returns Promise<T>

readJsonSync

readJsonSync<T>(path: string, options?: { encoding?: undefined | null; flag?: undefined | string } | null): T

- Defined in src/fs.ts:278
Type parameters
- T = any
Parameters
- path: string
- Optional options: { encoding?: undefined | null; flag?: undefined | string } | null
Returns T

rmrf

rmrf(path: string): Promise<void>

- Defined in src/fs.ts:221
Remove file or directory recursively, like rm -rf

Parameters
- path: string
  
  The path to remove
Returns Promise<void>

Index

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

Callback

Type declaration

fn: (args?: any) => void | Promise<void>

Parameters

Optional args: any

Returns void | Promise<void>

namespaces: string[]

Dependency

ListenerNames

LogLevels

OptionDef

TaskFn

Type parameters

O

T = any

Type declaration

Parameters

ctx: TaskContext<O>

Returns T | Promise<T>

WatchDirHandler

Type declaration

Parameters

event: string

filename: string

Returns void

WatchDirOptions

Type declaration

Optional persistent?: undefined | false | true

Optional threshold?: undefined | number

Variables

Const DefaultLogFile

Const EEXIST

Const ENOENT

Const TMKey

Const fs

Const logger

Let objUid

Let objUidMap

Const shellParser

Const spawn

Type declaration

Parameters

file: string

Optional arguments: readonly string[]

Optional options: execa.Options

Returns execa.ExecaChildProcess

Parameters

file: string

Optional arguments: readonly string[]

Optional options: execa.Options<null>

Returns execa.ExecaChildProcess<Buffer>

Parameters

file: string

Optional options: execa.Options

Returns execa.ExecaChildProcess

Parameters

file: string

Optional options: execa.Options<null>

Returns execa.ExecaChildProcess<Buffer>

command: function

Parameters

command: string

Optional options: execa.Options

Returns execa.ExecaChildProcess

Parameters

command: string

Optional options: execa.Options<null>

Returns execa.ExecaChildProcess<Buffer>

commandSync: function

Parameters