Module
class Module extends AbstractObject implements IdAble
A Dagger module.
Properties
| $lastQuery | from AbstractObject |
Methods
No description
The dependencies of the module.
The doc string of the module, if any
Enumerations served by this module.
The generated files and directories made on top of the module source's context directory.
A unique identifier for this Module.
Interfaces served by this module.
The name of the module
Objects served by this module.
The container that runs the module's entrypoint. It will fail to execute if the module doesn't compile.
Serve a module's API in the current session.
The source for the module.
Forces evaluation of the module, including any loading into the engine and associated validation.
Retrieves the module with the given description
This module plus the given Interface type and associated functions
This module plus the given Object type and associated functions.
Details
in
AbstractObject at line 13
__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)
No description
in
AbstractObject at line 19
protected null|array|string|int|float|bool
queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)
No description
at line 19
array
dependencies()
The dependencies of the module.
at line 28
string
description()
The doc string of the module, if any
at line 37
array
enums()
Enumerations served by this module.
at line 46
Directory
generatedContextDirectory()
The generated files and directories made on top of the module source's context directory.
at line 55
AbstractId
id()
A unique identifier for this Module.
at line 64
array
interfaces()
Interfaces served by this module.
at line 73
string
name()
The name of the module
at line 82
array
objects()
Objects served by this module.
at line 91
Container
runtime()
The container that runs the module's entrypoint. It will fail to execute if the module doesn't compile.
at line 100
SDKConfig
sdk()
The SDK config used by this module.
at line 111
void
serve()
Serve a module's API in the current session.
Note: this can only be called once per session. In the future, it could return a stream or service to remove the side effect.
at line 120
ModuleSource
source()
The source for the module.
at line 129
ModuleId
sync()
Forces evaluation of the module, including any loading into the engine and associated validation.
at line 138
Module
withDescription(string $description)
Retrieves the module with the given description
at line 148
Module
withEnum(TypeDef $enum)
This module plus the given Enum type and associated values
at line 158
Module
withInterface(TypeDef $iface)
This module plus the given Interface type and associated functions
at line 168
Module
withObject(TypeDef $object)
This module plus the given Object type and associated functions.