Search
Preparing search index...
The search index is not available
@circleci/circleci-config-sdk
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
@circleci/circleci-config-sdk
executors
Executor
Class Executor<ResourceClass>
Abstract
A generic reusable Executor.
Type Parameters
ResourceClass
extends
AnyResourceClass
=
AnyResourceClass
Hierarchy
Executor
DockerExecutor
MachineExecutor
MacOSExecutor
WindowsExecutor
Implements
Generable
Index
Constructors
constructor
Properties
resource_
class
Accessors
executor
Literal
generable
Type
generate
Resource
Class
Methods
generate
generate
Contents
to
Reusable
Constructors
constructor
new
Executor
<
ResourceClass
>
(
resource_class
:
ResourceClass
)
:
Executor
<
ResourceClass
>
Type Parameters
ResourceClass
extends
AnyResourceClass
=
AnyResourceClass
Parameters
resource_class:
ResourceClass
The resource class of the environment
Returns
Executor
<
ResourceClass
>
Properties
resource_
class
resource_
class
:
ResourceClass
Accessors
Abstract
executor
Literal
get
executorLiteral
(
)
:
ExecutorLiteral
Returns
ExecutorLiteral
Abstract
generable
Type
get
generableType
(
)
:
GenerableType
Returns
GenerableType
generate
Resource
Class
get
generateResourceClass
(
)
:
string
|
ResourceClass
Returns
string
|
ResourceClass
Methods
generate
generate
(
)
:
ExecutorShape
Returns
ExecutorShape
Abstract
generate
Contents
generate
Contents
(
)
:
unknown
Returns
unknown
to
Reusable
to
Reusable
(
name
:
string
, parameters
?:
CustomParametersList
<
ExecutorParameterLiteral
>
)
:
ReusableExecutor
Parameters
name:
string
Optional
parameters:
CustomParametersList
<
ExecutorParameterLiteral
>
Returns
ReusableExecutor
Exports
commands
executors
internal
Types
logic
mapping
orb
parameters
reusable
types
workflow
Executor
constructor
resource_
class
executor
Literal
generable
Type
generate
Resource
Class
generate
generate
Contents
to
Reusable
Generated using
TypeDoc
A generic reusable Executor.