Class TaskHost

Hierarchy

ScriptHost
Hierarchy
- TaskHost
  Hierarchy
  - TaskRunner

Constructors

constructor

new TaskHost(appName?: string, answerBuffer: string[]): TaskHost
Parameters
- appName: string = "Sequencer"
- answerBuffer: string[]
Returns TaskHost

Overrides ScriptHost.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` commandPrompt

commandPrompt: string

`Protected` `Readonly` config

config: Config

`Protected` `Readonly` copyrightPrompt

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

`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` shell

shell: TSubShell = ...

`Protected` `Readonly` subtaskTitles

subtaskTitles: string[] = []

`Protected` `Readonly` taskPrompt

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

`Protected` `Readonly` terminal

terminal: BufferedTerminal

`Protected` `Readonly` theme

theme: Theme

`Protected` `Readonly` times

times: bigint[] = []

`Protected` `Readonly` warningPrompt

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

Accessors

breadcrumbs

get breadcrumbs(): string
Returns string

Methods

`Protected` calcElapsedTime

calcElapsedTime(): bigint
Returns bigint

`Protected` checkInvalidSubtaskClosing

checkInvalidSubtaskClosing(): void
Throws
FalkorError: TaskHostErrorCodes.INVALID_SUBTASK_CLOSING

Returns void

`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

`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

`Protected` endSubtaskSuccess

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

`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 ScriptHost.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 ScriptHost.fetchJson

`Protected` fetchText

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

Inherited from ScriptHost.fetchText

`Protected` formatElapsedTime

formatElapsedTime(): string
Returns string

`Protected` sanitizeFetchOptions

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

Inherited from ScriptHost.sanitizeFetchOptions

`Protected` startSubtask

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

Class TaskHost

Hierarchy

Hierarchy

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

appName: string = "Sequencer"

answerBuffer: string[]

Returns TaskHost

Properties

Protected Readonly abortPrompt

Protected aborted

Protected appName

Protected Readonly ascii

Protected Readonly brand

Protected Readonly breadcrumbJoiner

Protected Readonly commandPrompt

Protected Readonly config

Protected Readonly copyrightPrompt

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 shell

Protected Readonly subtaskTitles

Protected Readonly taskPrompt

Protected Readonly terminal

Protected Readonly theme

Protected Readonly times

Protected Readonly warningPrompt

Accessors

breadcrumbs

Returns string

Methods

Protected calcElapsedTime

Returns bigint

Protected checkInvalidSubtaskClosing

Throws

Returns void

Protected endSubtaskAbort

Throws

Parameters

text: string

final: boolean = false

soft: boolean = false

Optional error: Error

Returns Error | FalkorError

Protected endSubtaskError

Throws

Parameters

text: string

final: boolean = false

soft: boolean = false

Optional error: Error

Returns Error | FalkorError

`Protected` `Readonly` abortPrompt

`Protected` aborted

`Protected` appName

`Protected` `Readonly` ascii

`Protected` `Readonly` brand

`Protected` `Readonly` breadcrumbJoiner

`Protected` `Readonly` commandPrompt

`Protected` `Readonly` config

`Protected` `Readonly` copyrightPrompt

`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` shell

`Protected` `Readonly` subtaskTitles

`Protected` `Readonly` taskPrompt

`Protected` `Readonly` terminal

`Protected` `Readonly` theme

`Protected` `Readonly` times

`Protected` `Readonly` warningPrompt

`Protected` calcElapsedTime

`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` sanitizeFetchOptions

`Protected` startSubtask