Skip to main content
Version: Next

TaskContext

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

Warning: This API is now obsolete.

this interface is planned to be removed. Please reach out to us in an issue if you're using this interface and your use cases.

TaskContext

Signature:

export interface TaskContext 

Properties

Property

Modifiers

Type

Description

cancelSignal

AbortSignal

createdBy?

string

(Optional)

done

boolean

isDryRun?

boolean

(Optional)

secrets?

TaskSecrets

(Optional)

spec

TaskSpec

taskId?

string

(Optional)

Methods

Method

Description

cleanWorkspace()?

(Optional)

complete(result, metadata)

emitLog(message, logMetadata)

getInitiatorCredentials()

getTaskState()?

(Optional)

getWorkspaceName()

rehydrateWorkspace(options)?

(Optional)

serializeWorkspace(options)?

(Optional)

updateCheckpoint(options)?

(Optional)