Skip to main content
Version: Next

TaskContext

Home > @backstage/plugin-scaffolder-node > TaskContext

Task

Signature:

export interface TaskContext 

Properties

Property

Modifiers

Type

Description

cancelSignal

AbortSignal

createdBy?

string

(Optional)

done

boolean

isDryRun?

boolean

(Optional)

secrets?

TaskSecrets

(Optional)

spec

TaskSpec

Methods

Method

Description

cleanWorkspace()?

(Optional)

complete(result, metadata)

emitLog(message, logMetadata)

getInitiatorCredentials()

getTaskState()?

(Optional)

getWorkspaceName()

rehydrateWorkspace(options)?

(Optional)

serializeWorkspace(options)?

(Optional)

updateCheckpoint(options)?

(Optional)