Class ExifToolTask<T>`Abstract`

Type Parameters

T

Hierarchy

Task<T>
- ExifToolTask

Index

Constructors

Properties

args command errors onProgress options? parser taskId warnings

Accessors

pending promise runtimeMs state timeoutElapsedMs

Methods

onStart onStderr onStdout parse reject resetTimeout toString renderCommand withoutProgressLines

Constructors

constructor

new ExifToolTask<T>(
args: string[],
options?: ExifToolTaskOptions & Partial<Pick<ExifToolOptions, "useMWG">>,
): ExifToolTask<T>
Type Parameters
- T
Parameters
- args: string[]
- Optionaloptions: ExifToolTaskOptions & Partial<Pick<ExifToolOptions, "useMWG">>
  pass the ExifTool instance's useMWG so this command matches every other command the instance sends.
Returns ExifToolTask<T>
Overrides bc.Task<T>.constructor
- Defined in src/ExifToolTask.ts:103

Properties

`Readonly`args

args: string[]

`Readonly`command

command: string

`Readonly`errors

errors: string[] = []

onProgress

onProgress: ((bytesHashed: number) => void) | undefined

See

ExifToolTaskProgressOptions.onProgress

`Optional` `Readonly`options

options?: ExifToolTaskOptions & Partial<Pick<ExifToolOptions, "useMWG">>

pass the ExifTool instance's useMWG so this command matches every other command the instance sends.

`Readonly`parser

parser: Parser<T>

`Readonly`taskId

taskId: number

`Readonly`warnings

warnings: string[] = []

Accessors

pending

get pending(): boolean
Returns boolean
Inherited from bc.Task.pending
- Defined in node_modules/batch-cluster/dist/Task.d.ts:25

promise

get promise(): Promise<T>
Returns Promise<T>
the resolution or rejection of this task.
Inherited from bc.Task.promise
- Defined in node_modules/batch-cluster/dist/Task.d.ts:24

runtimeMs

get runtimeMs(): number | undefined
Returns number | undefined
Inherited from bc.Task.runtimeMs
- Defined in node_modules/batch-cluster/dist/Task.d.ts:42

state

get state(): string
Returns string
Inherited from bc.Task.state
- Defined in node_modules/batch-cluster/dist/Task.d.ts:26

timeoutElapsedMs

get timeoutElapsedMs(): number | undefined
Time since this task started, or since its last timeout reset.

Returns number | undefined
Inherited from bc.Task.timeoutElapsedMs
- Defined in node_modules/batch-cluster/dist/Task.d.ts:41

Methods

onStart

onStart(
    opts: TaskOptions,
    beforeParse?: () => void,
    resetTimeout?: () => boolean,
): void
Called by BatchProcess when this task starts. Overrides must pass every argument to super.onStart(), or Task.resetTimeout stops working.
Parameters
- opts: TaskOptions
- OptionalbeforeParse: () => void
- OptionalresetTimeout: () => boolean
Returns void
Inherited from bc.Task.onStart
- Defined in node_modules/batch-cluster/dist/Task.d.ts:31

onStderr

onStderr(buf: string | Buffer<ArrayBufferLike>): void
Called with this task's stderr. Non-blank stderr is logged at warn, so a subclass that removes lines it understands before calling super.onStderr() keeps those lines out of the log.
Parameters
- buf: string | Buffer<ArrayBufferLike>
Returns void
Overrides bc.Task.onStderr
- Defined in src/ExifToolTask.ts:112

onStdout

onStdout(buf: string | Buffer<ArrayBufferLike>): void
Parameters
- buf: string | Buffer<ArrayBufferLike>
Returns void
Inherited from bc.Task.onStdout
- Defined in node_modules/batch-cluster/dist/Task.d.ts:44

`Protected` `Abstract`parse

parse(input: string, error?: Error): T
Parameters
- input: string
- Optionalerror: Error
Returns T
- Defined in src/ExifToolTask.ts:166

reject

reject(error: Error): boolean
Parameters
- error: Error
Returns boolean
true if the wrapped promise was rejected
Inherited from bc.Task.reject
- Defined in node_modules/batch-cluster/dist/Task.d.ts:54

resetTimeout

resetTimeout(): boolean
Restart this task's timeout. Call this only after verifying that the task made progress: output alone is not progress.

Returns boolean
false if the task isn't running or has no timeout, and for startup and health-check tasks.
Inherited from bc.Task.resetTimeout
- Defined in node_modules/batch-cluster/dist/Task.d.ts:39

toString

toString(): string
Returns string
Inherited from bc.Task.toString
- Defined in node_modules/batch-cluster/dist/Task.d.ts:43

`Static`renderCommand

renderCommand(
args: string[],
options?: ExifToolTaskOptions & Partial<Pick<ExifToolOptions, "useMWG">>,
): string
Parameters
- args: string[]
- Optionaloptions: ExifToolTaskOptions & Partial<Pick<ExifToolOptions, "useMWG">>
Returns string
- Defined in src/ExifToolTask.ts:47

`Static`withoutProgressLines

withoutProgressLines(stderr: string): { bytes: number[]; rest: string }
Splits ExifTool's {progress:BYTES} lines from the rest of stderr.
Parameters
- stderr: string
Returns { bytes: number[]; rest: string }
- Defined in src/ExifToolTask.ts:79