Class TaskRunner

Hierarchy

TaskHost
Hierarchy
- TaskRunner

Constructors

constructor

new TaskRunner(appName?: string, answerBuffer?: string[]): TaskRunner
Parameters
- Optional appName: string
- answerBuffer: string[] = null
Returns TaskRunner

Overrides TaskHost.constructor

Properties

`Protected` `Readonly` abortPrompt

abortPrompt: "[A]" = "[A]"

`Protected` aborted

aborted: boolean = false

`Protected` appName

appName: string = "Sequencer"

`Protected` `Readonly` ascii

ascii: Ascii

`Protected` `Readonly` brand

brand: Brand

`Protected` `Readonly` breadcrumbJoiner

breadcrumbJoiner: " > " = " > "

`Protected` `Readonly` collection

collection: { [id: string]: Task } = {}

Type declaration

[id: string]: Task

`Protected` `Readonly` commandPrompt

commandPrompt: string

`Protected` `Readonly` config

config: Config

`Protected` `Readonly` copyrightPrompt

copyrightPrompt: "[C]" = "[C]"

`Protected` currentIndex

currentIndex: number = null

`Protected` currentSequence

currentSequence: string[]

`Protected` currentSequenceArguments

currentSequenceArguments: { [key: string]: { [key: string]: any } }

Type declaration

[key: string]: { [key: string]: any }
- [key: string]: any

`Protected` currentTask

currentTask: Task = null

`Protected` `Readonly` debugPrompt

debugPrompt: "[;]" = "[;]"

`Protected` `Readonly` defaultExecOptions

defaultExecOptions: { async: boolean; silent: boolean } = ...

Type declaration

async: boolean
silent: boolean

`Protected` `Readonly` defaultFetchJsonOptions

defaultFetchJsonOptions: { headers: { Content-Type: string }; method: string } = ...

Type declaration

headers: { Content-Type: string }
- Content-Type: string
method: string

`Protected` `Readonly` defaultFetchTextOptions

defaultFetchTextOptions: { headers: { Content-Type: string }; method: string } = ...

Type declaration

headers: { Content-Type: string }
- Content-Type: string
method: string

`Protected` `Readonly` errorPrompt

errorPrompt: "[!]" = "[!]"

`Protected` `Readonly` fetchPrompt

fetchPrompt: string

`Protected` finalPromptCount

finalPromptCount: number = 1

`Protected` finalTaskCount

finalTaskCount: number = 1

`Protected` finalTimeCount

finalTimeCount: number = 1

`Protected` `Readonly` infoPrompt

infoPrompt: "[i]" = "[i]"

`Protected` `Readonly` logger

logger: Logger

`Protected` `Readonly` panicPrompt

panicPrompt: "[P]" = "[P]"

`Protected` `Readonly` prefix

prefix: string = ...

`Protected` `Readonly` reservedTaskNames

reservedTaskNames: string[] = ...

`Protected` `Readonly` shell

shell: TSubShell = ...

`Protected` `Readonly` subtaskTitles

subtaskTitles: string[] = []

`Protected` `Readonly` taskOptions

taskOptions: TTaskSetupOptions = ...

`Protected` `Readonly` taskPrompt

taskPrompt: "[#]" = "[#]"

`Protected` `Readonly` terminal

terminal: BufferedTerminal

`Protected` `Readonly` theme

theme: Theme

`Protected` `Readonly` times

times: bigint[] = []

`Protected` `Readonly` versionRe

versionRe: RegExp = ...

`Protected` `Readonly` warningPrompt

warningPrompt: "[w]" = "[w]"

Accessors

breadcrumbs

get breadcrumbs(): string
Returns string

Inherited from TaskHost.breadcrumbs

Methods

`Protected` calcElapsedTime

calcElapsedTime(): bigint
Returns bigint

Inherited from TaskHost.calcElapsedTime

`Protected` checkDependencies

checkDependencies(dependencies: TCommandDependencies<SemVer>): Promise<void>
Parameters
- dependencies: TCommandDependencies<SemVer>
Returns Promise<void>

`Protected` checkInvalidSubtaskClosing

checkInvalidSubtaskClosing(): void
Throws
FalkorError: TaskHostErrorCodes.INVALID_SUBTASK_CLOSING

Returns void

Inherited from TaskHost.checkInvalidSubtaskClosing

`Protected` endSubtaskAbort

endSubtaskAbort(text: string, final?: boolean, soft?: boolean, error?: Error): Error | FalkorError
Throws
FalkorError: TaskHostErrorCodes.SUBTASK_ABORT
Parameters
- text: string
- final: boolean = false
- soft: boolean = false
- Optional error: Error
Returns Error | FalkorError

Inherited from TaskHost.endSubtaskAbort

`Protected` endSubtaskError

endSubtaskError(text: string, final?: boolean, soft?: boolean, error?: Error): Error | FalkorError
Throws
FalkorError: TaskHostErrorCodes.SUBTASK_ERROR
Parameters
- text: string
- final: boolean = false
- soft: boolean = false
- Optional error: Error
Returns Error | FalkorError

Inherited from TaskHost.endSubtaskError

`Protected` endSubtaskSuccess

endSubtaskSuccess(text: string): void
Parameters
- text: string
Returns void

Inherited from TaskHost.endSubtaskSuccess

`Protected` exec

exec(command: string, options?: { logLevel?: LogLevel; noError?: RegExp[] } & ExecOptions): Promise<TExecReturnValue>
Parameters
- command: string
- Optional options: { logLevel?: LogLevel; noError?: RegExp[] } & ExecOptions
Returns Promise<TExecReturnValue>

Inherited from TaskHost.exec

`Protected` fetchJson

fetchJson<T>(url: string, options?: RequestInit): Promise<TFetchReturnValue<T>>
Type Parameters
Type Parameters
- T
Parameters
- url: string
- options: RequestInit = null
Returns Promise<TFetchReturnValue<T>>

Inherited from TaskHost.fetchJson

`Protected` fetchText

fetchText(url: string, options?: RequestInit): Promise<TFetchReturnValue<string>>
Parameters
- url: string
- options: RequestInit = null
Returns Promise<TFetchReturnValue<string>>

Inherited from TaskHost.fetchText

`Protected` formatElapsedTime

formatElapsedTime(): string
Returns string

Inherited from TaskHost.formatElapsedTime

`Protected` handleError

handleError(error: Error, soft?: boolean): Error | FalkorError
Parameters
- error: Error
- soft: boolean = false
Returns Error | FalkorError

`Protected` logAbort

logAbort(): void
Returns void

`Protected` logError

logError(error: Error, soft: boolean): void
Parameters
- error: Error
- soft: boolean
Returns void

`Protected` mergeDependencies

mergeDependencies(target: TCommandDependencies<SemVer>): void
Throws
FalkorError: TaskRunnerErrorCodes.INVALID_ID
Parameters
- target: TCommandDependencies<SemVer>
Returns void

register

register(task: Task): void
Throws
FalkorError: TaskRunnerErrorCodes.RESERVED_ID

Throws
FalkorError: TaskRunnerErrorCodes.DUPLICATE_ID
Parameters
- task: Task
Returns void

run

run(idArr?: string | string[], argumentVector?: { [key: string]: { [key: string]: any } }): Promise<void>
Parameters
- Optional idArr: string | string[]
- Optional argumentVector: { [key: string]: { [key: string]: any } }
  - [key: string]: { [key: string]: any }
    - [key: string]: any
Returns Promise<void>

`Protected` runSequence

runSequence(): Promise<void>
Returns Promise<void>

`Protected` sanitizeFetchOptions

sanitizeFetchOptions(builtIn: RequestInit, options: RequestInit): RequestInit
Parameters
- builtIn: RequestInit
- options: RequestInit
Returns RequestInit

Inherited from TaskHost.sanitizeFetchOptions

`Protected` `Readonly` sigintListener

sigintListener(): Error | FalkorError
Returns Error | FalkorError

`Protected` startSubtask

startSubtask(title: string): void
Parameters
- title: string
Returns void

Inherited from TaskHost.startSubtask

Class TaskRunner

Hierarchy

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional appName: string

answerBuffer: string[] = null

Returns TaskRunner

Properties

Protected Readonly abortPrompt

Protected aborted

Protected appName

Protected Readonly ascii

Protected Readonly brand

Protected Readonly breadcrumbJoiner

Protected Readonly collection

Type declaration

[id: string]: Task

Protected Readonly commandPrompt

Protected Readonly config

Protected Readonly copyrightPrompt

Protected currentIndex

Protected currentSequence

Protected currentSequenceArguments

Type declaration

[key: string]: { [key: string]: any }

[key: string]: any

Protected currentTask

Protected Readonly debugPrompt

Protected Readonly defaultExecOptions

Type declaration

async: boolean

silent: boolean

Protected Readonly defaultFetchJsonOptions

Type declaration

headers: { Content-Type: string }

Content-Type: string

method: string

Protected Readonly defaultFetchTextOptions

Type declaration

headers: { Content-Type: string }

Content-Type: string

method: string

Protected Readonly errorPrompt

Protected Readonly fetchPrompt

Protected finalPromptCount

Protected finalTaskCount

Protected finalTimeCount

Protected Readonly infoPrompt

Protected Readonly logger

Protected Readonly panicPrompt

Protected Readonly prefix

Protected Readonly reservedTaskNames

Protected Readonly shell

Protected Readonly subtaskTitles

Protected Readonly taskOptions

Protected Readonly taskPrompt

Protected Readonly terminal

Protected Readonly theme

Protected Readonly times

Protected Readonly versionRe

Protected Readonly warningPrompt

Accessors

breadcrumbs

Returns string

Methods

Protected calcElapsedTime

Returns bigint

Protected checkDependencies

Parameters

dependencies: TCommandDependencies<SemVer>

Returns Promise<void>

Protected checkInvalidSubtaskClosing

Throws

`Optional` appName: string

`Protected` `Readonly` abortPrompt

`Protected` aborted

`Protected` appName

`Protected` `Readonly` ascii

`Protected` `Readonly` brand

`Protected` `Readonly` breadcrumbJoiner

`Protected` `Readonly` collection

`Protected` `Readonly` commandPrompt

`Protected` `Readonly` config

`Protected` `Readonly` copyrightPrompt

`Protected` currentIndex

`Protected` currentSequence

`Protected` currentSequenceArguments

`Protected` currentTask

`Protected` `Readonly` debugPrompt

`Protected` `Readonly` defaultExecOptions

`Protected` `Readonly` defaultFetchJsonOptions

`Protected` `Readonly` defaultFetchTextOptions

`Protected` `Readonly` errorPrompt

`Protected` `Readonly` fetchPrompt

`Protected` finalPromptCount

`Protected` finalTaskCount

`Protected` finalTimeCount

`Protected` `Readonly` infoPrompt

`Protected` `Readonly` logger

`Protected` `Readonly` panicPrompt

`Protected` `Readonly` prefix

`Protected` `Readonly` reservedTaskNames

`Protected` `Readonly` shell

`Protected` `Readonly` subtaskTitles

`Protected` `Readonly` taskOptions

`Protected` `Readonly` taskPrompt

`Protected` `Readonly` terminal

`Protected` `Readonly` theme

`Protected` `Readonly` times

`Protected` `Readonly` versionRe

`Protected` `Readonly` warningPrompt

`Protected` calcElapsedTime

`Protected` checkDependencies

`Protected` checkInvalidSubtaskClosing

`Protected` endSubtaskAbort

`Optional` error: Error

`Protected` endSubtaskError

`Optional` error: Error

`Protected` endSubtaskSuccess

`Protected` exec

`Optional` options: { logLevel?: LogLevel; noError?: RegExp[] } & ExecOptions

`Protected` fetchJson

`Protected` fetchText

`Protected` formatElapsedTime

`Protected` handleError

`Protected` logAbort

`Protected` logError

`Protected` mergeDependencies

`Optional` idArr: string | string[]

`Optional` argumentVector: { [key: string]: { [key: string]: any } }