Module
class Module extends AbstractObject implements IdAble
A Dagger module.
Properties
| $lastQuery | from AbstractObject |
Methods
No description
Return the check defined by the module with the given name. Must match to exactly one check.
Return all checks defined by the module
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.
Return the generator defined by the module with the given name. Must match to exactly one generator.
Return all generators defined by the module
A unique identifier for this Module.
Interfaces served by this module.
The introspection schema JSON file for 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.
User-defined default values, loaded from local .env files.
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
Check
check(string $name)
Return the check defined by the module with the given name. Must match to exactly one check.
at line 29
CheckGroup
checks(array|null $include = null, bool|null $noGenerate = null)
Return all checks defined by the module
at line 44
array
dependencies()
The dependencies of the module.
at line 53
string
description()
The doc string of the module, if any
at line 62
array
enums()
Enumerations served by this module.
at line 71
Directory
generatedContextDirectory()
The generated files and directories made on top of the module source's context directory.
at line 80
Generator
generator(string $name)
Return the generator defined by the module with the given name. Must match to exactly one generator.
at line 90
GeneratorGroup
generators(array|null $include = null)
Return all generators defined by the module
at line 102
AbstractId
id()
A unique identifier for this Module.
at line 111
array
interfaces()
Interfaces served by this module.
at line 124
File
introspectionSchemaJSON()
The introspection schema JSON file for this module.
This file represents the schema visible to the module's source code, including all core types and those from the dependencies.
Note: this is in the context of a module, so some core types may be hidden.
at line 133
string
name()
The name of the module
at line 142
array
objects()
Objects served by this module.
at line 151
Container
runtime()
The container that runs the module's entrypoint. It will fail to execute if the module doesn't compile.
at line 160
SDKConfig
sdk()
The SDK config used by this module.
at line 171
void
serve(bool|null $includeDependencies = null, bool|null $entrypoint = null)
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 186
UpGroup
services(array|null $include = null)
Return all services defined by the module
at line 198
ModuleSource
source()
The source for the module.
at line 207
ModuleId
sync()
Forces evaluation of the module, including any loading into the engine and associated validation.
at line 216
EnvFile
userDefaults()
User-defined default values, loaded from local .env files.
at line 225
Module
withDescription(string $description)
Retrieves the module with the given description
at line 235
Module
withEnum(TypeDef $enum)
This module plus the given Enum type and associated values
at line 245
Module
withInterface(TypeDef $iface)
This module plus the given Interface type and associated functions
at line 255
Module
withObject(TypeDef $object)
This module plus the given Object type and associated functions.