footprintjs - v11.2.0
Docs
Import map
GitHub
npm
Playground
Preparing search index...
footprintjs/advanced
StageContextLike
Interface StageContextLike
Minimal surface from StageContext (patch-based)
interface
StageContextLike
{
pipelineId
?:
string
;
runId
?:
string
;
addError
?
(
key
:
string
,
val
:
unknown
)
:
void
;
addLog
?
(
key
:
string
,
val
:
unknown
)
:
void
;
getGlobal
?
(
key
:
string
)
:
unknown
;
getValue
(
path
:
string
[]
,
key
?:
string
)
:
unknown
;
setGlobal
?
(
key
:
string
,
value
:
unknown
,
description
?:
string
)
:
void
;
setObject
(
path
:
string
[]
,
key
:
string
,
value
:
unknown
,
shouldRedact
?:
boolean
,
description
?:
string
,
)
:
void
;
setRoot
?
(
key
:
string
,
value
:
unknown
)
:
void
;
updateObject
(
path
:
string
[]
,
key
:
string
,
value
:
unknown
,
description
?:
string
,
)
:
void
;
}
Index
Properties
pipeline
Id?
run
Id?
Methods
add
Error?
add
Log?
get
Global?
get
Value
set
Global?
set
Object
set
Root?
update
Object
Properties
Optional
pipeline
Id
pipelineId
?:
string
Optional
run
Id
runId
?:
string
Methods
Optional
add
Error
addError
?
(
key
:
string
,
val
:
unknown
)
:
void
Parameters
key
:
string
val
:
unknown
Returns
void
Optional
add
Log
addLog
?
(
key
:
string
,
val
:
unknown
)
:
void
Parameters
key
:
string
val
:
unknown
Returns
void
Optional
get
Global
getGlobal
?
(
key
:
string
)
:
unknown
Parameters
key
:
string
Returns
unknown
get
Value
getValue
(
path
:
string
[]
,
key
?:
string
)
:
unknown
Parameters
path
:
string
[]
Optional
key
:
string
Returns
unknown
Optional
set
Global
setGlobal
?
(
key
:
string
,
value
:
unknown
,
description
?:
string
)
:
void
Parameters
key
:
string
value
:
unknown
Optional
description
:
string
Returns
void
set
Object
setObject
(
path
:
string
[]
,
key
:
string
,
value
:
unknown
,
shouldRedact
?:
boolean
,
description
?:
string
,
)
:
void
Parameters
path
:
string
[]
key
:
string
value
:
unknown
Optional
shouldRedact
:
boolean
Optional
description
:
string
Returns
void
Optional
set
Root
setRoot
?
(
key
:
string
,
value
:
unknown
)
:
void
Parameters
key
:
string
value
:
unknown
Returns
void
update
Object
updateObject
(
path
:
string
[]
,
key
:
string
,
value
:
unknown
,
description
?:
string
,
)
:
void
Parameters
path
:
string
[]
key
:
string
value
:
unknown
Optional
description
:
string
Returns
void
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
Properties
pipeline
Id
run
Id
Methods
add
Error
add
Log
get
Global
get
Value
set
Global
set
Object
set
Root
update
Object
Docs
Import map
GitHub
npm
Playground
footprintjs - v11.2.0
Loading...
Minimal surface from StageContext (patch-based)