Class: Client
The root of the DAG.
Extends
BaseClient
Constructors
new Client()
new Client(
parent?,_defaultPlatform?,_version?):Client
Constructor is used for internal usage only, do not create object from it.
Parameters
• parent?
• parent.ctx?: Context
• parent.queryTree?: QueryTree[]
• _defaultPlatform?: Platform
• _version?: string
Returns
Overrides
BaseClient.constructor
Methods
blob()
blob(
digest,size,mediaType,uncompressed):Directory
Retrieves a content-addressed blob.
Parameters
• digest: string
Digest of the blob
• size: number
Size of the blob
• mediaType: string
Media type of the blob
• uncompressed: string
Digest of the uncompressed blob
Returns
builtinContainer()
builtinContainer(
digest):Container
Retrieves a container builtin to the engine.
Parameters
• digest: string
Digest of the image manifest
Returns
cacheVolume()
cacheVolume(
key):CacheVolume
Constructs a cache volume for a given cache key.
Parameters
• key: string
A string identifier to target this cache volume (e.g., "modules-cache").
Returns
container()
container(
opts?):Container
Creates a scratch container.
Optional platform argument initializes new containers to execute and publish as that platform. Platform defaults to that of the builder's host.
Parameters
• opts?: ClientContainerOpts
Returns
currentFunctionCall()
currentFunctionCall():
FunctionCall
The FunctionCall context that the SDK caller is currently executing in.
If the caller is not currently executing in a function, this will return an error.
Returns
currentModule()
currentModule():
CurrentModule
The module currently being served in the session, if any.
Returns
currentTypeDefs()
currentTypeDefs():
Promise<TypeDef[]>
The TypeDef representations of the objects currently being served in the session.
Returns
Promise<TypeDef[]>
defaultPlatform()
defaultPlatform():
Promise<Platform>
The default platform of the engine.
Returns
Promise<Platform>
directory()
directory():
Directory
Creates an empty directory.
Returns
engine()
engine():
Engine
The Dagger engine container configuration and state
Returns
error()
error(
message):Error
Create a new error.
Parameters
• message: string
A brief description of the error.
Returns
function_()
function_(
name,returnType):Function_
Creates a function.
Parameters
• name: string
Name of the function, in its original format from the implementation language.
• returnType: TypeDef
Return type of the function.
Returns
generatedCode()
generatedCode(
code):GeneratedCode
Create a code generation result, given a directory containing the generated code.
Parameters
• code: Directory
Returns
getGQLClient()
getGQLClient():
GraphQLClient
Get the Raw GraphQL client.
Returns
GraphQLClient
git()
git(
url,opts?):GitRepository
Queries a Git repository.
Parameters
• url: string
URL of the git repository.
Can be formatted as https://{host}/{owner}/{repo}, git@{host}:{owner}/{repo}.
Suffix ".git" is optional.
• opts?: ClientGitOpts
Returns
host()
host():
Host
Queries the host environment.
Returns
http()
http(
url,opts?):File
Returns a file containing an http remote url content.
Parameters
• url: string
HTTP url to get the content from (e.g., "https://docs.dagger.io").
• opts?: ClientHttpOpts
Returns
loadCacheVolumeFromID()
loadCacheVolumeFromID(
id):CacheVolume
Load a CacheVolume from its ID.
Parameters
• id: CacheVolumeID
Returns
loadContainerFromID()
loadContainerFromID(
id):Container
Load a Container from its ID.
Parameters
• id: ContainerID
Returns
loadCurrentModuleFromID()
loadCurrentModuleFromID(
id):CurrentModule
Load a CurrentModule from its ID.
Parameters
• id: CurrentModuleID
Returns
loadDirectoryFromID()
loadDirectoryFromID(
id):Directory
Load a Directory from its ID.
Parameters
• id: DirectoryID
Returns
loadEngineCacheEntryFromID()
loadEngineCacheEntryFromID(
id):EngineCacheEntry
Load a EngineCacheEntry from its ID.
Parameters
• id: EngineCacheEntryID
Returns
loadEngineCacheEntrySetFromID()
loadEngineCacheEntrySetFromID(
id):EngineCacheEntrySet
Load a EngineCacheEntrySet from its ID.
Parameters
• id: EngineCacheEntrySetID
Returns
loadEngineCacheFromID()
loadEngineCacheFromID(
id):EngineCache
Load a EngineCache from its ID.
Parameters
• id: EngineCacheID
Returns
loadEngineFromID()
loadEngineFromID(
id):Engine
Load a Engine from its ID.
Parameters
• id: EngineID
Returns
loadEnumTypeDefFromID()
loadEnumTypeDefFromID(
id):EnumTypeDef
Load a EnumTypeDef from its ID.
Parameters
• id: EnumTypeDefID
Returns
loadEnumValueTypeDefFromID()
loadEnumValueTypeDefFromID(
id):EnumValueTypeDef
Load a EnumValueTypeDef from its ID.
Parameters
• id: EnumValueTypeDefID
Returns
loadEnvVariableFromID()
loadEnvVariableFromID(
id):EnvVariable
Load a EnvVariable from its ID.
Parameters
• id: EnvVariableID
Returns
loadErrorFromID()
loadErrorFromID(
id):Error
Load a Error from its ID.
Parameters
• id: ErrorID
Returns
loadFieldTypeDefFromID()
loadFieldTypeDefFromID(
id):FieldTypeDef
Load a FieldTypeDef from its ID.
Parameters
• id: FieldTypeDefID
Returns
loadFileFromID()
loadFileFromID(
id):File
Load a File from its ID.
Parameters
• id: FileID
Returns
loadFunctionArgFromID()
loadFunctionArgFromID(
id):FunctionArg
Load a FunctionArg from its ID.
Parameters
• id: FunctionArgID
Returns
loadFunctionCallArgValueFromID()
loadFunctionCallArgValueFromID(
id):FunctionCallArgValue
Load a FunctionCallArgValue from its ID.
Parameters
• id: FunctionCallArgValueID
Returns
loadFunctionCallFromID()
loadFunctionCallFromID(
id):FunctionCall
Load a FunctionCall from its ID.
Parameters
• id: FunctionCallID
Returns
loadFunctionFromID()
loadFunctionFromID(
id):Function_
Load a Function from its ID.
Parameters
• id: FunctionID
Returns
loadGeneratedCodeFromID()
loadGeneratedCodeFromID(
id):GeneratedCode
Load a GeneratedCode from its ID.
Parameters
• id: GeneratedCodeID
Returns
loadGitModuleSourceFromID()
loadGitModuleSourceFromID(
id):GitModuleSource
Load a GitModuleSource from its ID.
Parameters
• id: GitModuleSourceID
Returns
loadGitRefFromID()
loadGitRefFromID(
id):GitRef
Load a GitRef from its ID.
Parameters
• id: GitRefID
Returns
loadGitRepositoryFromID()
loadGitRepositoryFromID(
id):GitRepository
Load a GitRepository from its ID.
Parameters
• id: GitRepositoryID
Returns
loadHostFromID()
loadHostFromID(
id):Host
Load a Host from its ID.
Parameters
• id: HostID
Returns
loadInputTypeDefFromID()
loadInputTypeDefFromID(
id):InputTypeDef
Load a InputTypeDef from its ID.
Parameters
• id: InputTypeDefID
Returns
loadInterfaceTypeDefFromID()
loadInterfaceTypeDefFromID(
id):InterfaceTypeDef
Load a InterfaceTypeDef from its ID.
Parameters
• id: InterfaceTypeDefID
Returns
loadLabelFromID()
loadLabelFromID(
id):Label
Load a Label from its ID.
Parameters
• id: LabelID
Returns
loadListTypeDefFromID()
loadListTypeDefFromID(
id):ListTypeDef
Load a ListTypeDef from its ID.
Parameters
• id: ListTypeDefID
Returns
loadLocalModuleSourceFromID()
loadLocalModuleSourceFromID(
id):LocalModuleSource
Load a LocalModuleSource from its ID.
Parameters
• id: LocalModuleSourceID
Returns
loadModuleDependencyFromID()
loadModuleDependencyFromID(
id):ModuleDependency
Load a ModuleDependency from its ID.
Parameters
• id: ModuleDependencyID
Returns
loadModuleFromID()
loadModuleFromID(
id):Module_
Load a Module from its ID.
Parameters
• id: ModuleID
Returns
loadModuleSourceFromID()
loadModuleSourceFromID(
id):ModuleSource
Load a ModuleSource from its ID.
Parameters
• id: ModuleSourceID
Returns
loadModuleSourceViewFromID()
loadModuleSourceViewFromID(
id):ModuleSourceView
Load a ModuleSourceView from its ID.
Parameters
• id: ModuleSourceViewID
Returns
loadObjectTypeDefFromID()
loadObjectTypeDefFromID(
id):ObjectTypeDef
Load a ObjectTypeDef from its ID.
Parameters
• id: ObjectTypeDefID
Returns
loadPortFromID()
loadPortFromID(
id):Port
Load a Port from its ID.
Parameters
• id: PortID
Returns
loadScalarTypeDefFromID()
loadScalarTypeDefFromID(
id):ScalarTypeDef
Load a ScalarTypeDef from its ID.
Parameters
• id: ScalarTypeDefID
Returns
loadSecretFromID()
loadSecretFromID(
id):Secret
Load a Secret from its ID.
Parameters
• id: SecretID
Returns
loadServiceFromID()
loadServiceFromID(
id):Service
Load a Service from its ID.
Parameters
• id: ServiceID
Returns
loadSocketFromID()
loadSocketFromID(
id):Socket
Load a Socket from its ID.
Parameters
• id: SocketID
Returns
loadSourceMapFromID()
loadSourceMapFromID(
id):SourceMap
Load a SourceMap from its ID.
Parameters
• id: SourceMapID
Returns
loadTerminalFromID()
loadTerminalFromID(
id):Terminal
Load a Terminal from its ID.
Parameters
• id: TerminalID
Returns
loadTypeDefFromID()
loadTypeDefFromID(
id):TypeDef
Load a TypeDef from its ID.
Parameters
• id: TypeDefID
Returns
module_()
module_():
Module_
Create a new module.
Returns
moduleDependency()
moduleDependency(
source,opts?):ModuleDependency
Create a new module dependency configuration from a module source and name
Parameters
• source: ModuleSource
The source of the dependency
• opts?: ClientModuleDependencyOpts
Returns
moduleSource()
moduleSource(
refString,opts?):ModuleSource
Create a new module source instance from a source ref string.
Parameters
• refString: string
The string ref representation of the module source
• opts?: ClientModuleSourceOpts
Returns
secret()
secret(
name,opts?):Secret
Reference a secret by name.
Parameters
• name: string
• opts?: ClientSecretOpts
Returns
setSecret()
setSecret(
name,plaintext):Secret
Sets a secret given a user defined name to its plaintext and returns the secret.
The plaintext value is limited to a size of 128000 bytes.
Parameters
• name: string
The user defined name for this secret
• plaintext: string
The plaintext of the secret
Returns
sourceMap()
sourceMap(
filename,line,column):SourceMap
Creates source map metadata.
Parameters
• filename: string
The filename from the module source.
• line: number
The line number within the filename.
• column: number
The column number within the line.
Returns
typeDef()
typeDef():
TypeDef
Create a new TypeDef.
Returns
version()
version():
Promise<string>
Get the current Dagger Engine version.
Returns
Promise<string>