Dagger
Search

elixir-sdk

No long description provided.

Installation

dagger install github.com/dagger/dagger/sdk/elixir@v0.13.3

Entrypoint

Return Type 
ElixirSdk !
Arguments
NameTypeDefault ValueDescription
sdkSourceDirDirectory -Directory with the Elixir SDK source code.
Example
dagger -m github.com/dagger/dagger/sdk/elixir@d3a02170c96d4d81343dbbcd5c555ba6b8d38b45 call \

func (m *myModule) example() *ElixirSdk  {
	return dag.
			ElixirSdk()
}
@function
def example() -> dag.ElixirSdk:
	return (
		dag.elixir_sdk()
	)
@func()
example(): ElixirSdk {
	return dag
		.elixirSdk()
}

Types

ElixirSdk 🔗

sdkSourceDir() 🔗

Return Type 
Directory !
Example
dagger -m github.com/dagger/dagger/sdk/elixir@d3a02170c96d4d81343dbbcd5c555ba6b8d38b45 call \
 sdk-source-dir
func (m *myModule) example() *Directory  {
	return dag.
			ElixirSdk().
			SdkSourceDir()
}
@function
def example() -> dagger.Directory:
	return (
		dag.elixir_sdk()
		.sdk_source_dir()
	)
@func()
example(): Directory {
	return dag
		.elixirSdk()
		.sdkSourceDir()
}

requiredPaths() 🔗

Return Type 
[String ! ] !
Example
dagger -m github.com/dagger/dagger/sdk/elixir@d3a02170c96d4d81343dbbcd5c555ba6b8d38b45 call \
 required-paths
func (m *myModule) example(ctx context.Context) []string  {
	return dag.
			ElixirSdk().
			RequiredPaths(ctx)
}
@function
async def example() -> List[str]:
	return await (
		dag.elixir_sdk()
		.required_paths()
	)
@func()
async example(): Promise<string[]> {
	return dag
		.elixirSdk()
		.requiredPaths()
}

container() 🔗

Return Type 
Container !
Example
dagger -m github.com/dagger/dagger/sdk/elixir@d3a02170c96d4d81343dbbcd5c555ba6b8d38b45 call \
 container
func (m *myModule) example() *Container  {
	return dag.
			ElixirSdk().
			Container()
}
@function
def example() -> dagger.Container:
	return (
		dag.elixir_sdk()
		.container()
	)
@func()
example(): Container {
	return dag
		.elixirSdk()
		.container()
}

moduleRuntime() 🔗

Return Type 
Container !
Arguments
NameTypeDefault ValueDescription
modSourceModuleSource !-No description provided
introspectionJsonFile !-No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *myModule) example(modSource *ModuleSource, introspectionJson *File) *Container  {
	return dag.
			ElixirSdk().
			ModuleRuntime(modSource, introspectionJson)
}
@function
def example(mod_source: dag.ModuleSource, introspection_json: dagger.File) -> dagger.Container:
	return (
		dag.elixir_sdk()
		.module_runtime(mod_source, introspection_json)
	)
@func()
example(modSource: ModuleSource, introspectionJson: File): Container {
	return dag
		.elixirSdk()
		.moduleRuntime(modSource, introspectionJson)
}

codegen() 🔗

Return Type 
GeneratedCode !
Arguments
NameTypeDefault ValueDescription
modSourceModuleSource !-No description provided
introspectionJsonFile !-No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *myModule) example(modSource *ModuleSource, introspectionJson *File) *GeneratedCode  {
	return dag.
			ElixirSdk().
			Codegen(modSource, introspectionJson)
}
@function
def example(mod_source: dag.ModuleSource, introspection_json: dagger.File) -> dag.GeneratedCode:
	return (
		dag.elixir_sdk()
		.codegen(mod_source, introspection_json)
	)
@func()
example(modSource: ModuleSource, introspectionJson: File): GeneratedCode {
	return dag
		.elixirSdk()
		.codegen(modSource, introspectionJson)
}

common() 🔗

Return Type 
Container !
Arguments
NameTypeDefault ValueDescription
modSourceModuleSource !-No description provided
introspectionJsonFile !-No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *myModule) example(modSource *ModuleSource, introspectionJson *File) *Container  {
	return dag.
			ElixirSdk().
			Common(modSource, introspectionJson)
}
@function
def example(mod_source: dag.ModuleSource, introspection_json: dagger.File) -> dagger.Container:
	return (
		dag.elixir_sdk()
		.common(mod_source, introspection_json)
	)
@func()
example(modSource: ModuleSource, introspectionJson: File): Container {
	return dag
		.elixirSdk()
		.common(modSource, introspectionJson)
}

base() 🔗

Return Type 
ElixirSdk !
Arguments
NameTypeDefault ValueDescription
modSourceModuleSource !-No description provided
subPathString !-No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *myModule) example(modSource *ModuleSource, subPath string) *ElixirSdk  {
	return dag.
			ElixirSdk().
			Base(modSource, subPath)
}
@function
def example(mod_source: dag.ModuleSource, sub_path: str) -> dag.ElixirSdk:
	return (
		dag.elixir_sdk()
		.base(mod_source, sub_path)
	)
@func()
example(modSource: ModuleSource, subPath: string): ElixirSdk {
	return dag
		.elixirSdk()
		.base(modSource, subPath)
}

withNewElixirPackage() 🔗

Generate a new Elixir package named by modName. This step will ignored if the package already generated.

Return Type 
ElixirSdk !
Arguments
NameTypeDefault ValueDescription
modNameString !-No description provided
Example
dagger -m github.com/dagger/dagger/sdk/elixir@d3a02170c96d4d81343dbbcd5c555ba6b8d38b45 call \
 with-new-elixir-package --mod-name string
func (m *myModule) example(modName string) *ElixirSdk  {
	return dag.
			ElixirSdk().
			WithNewElixirPackage(modName)
}
@function
def example(mod_name: str) -> dag.ElixirSdk:
	return (
		dag.elixir_sdk()
		.with_new_elixir_package(mod_name)
	)
@func()
example(modName: string): ElixirSdk {
	return dag
		.elixirSdk()
		.withNewElixirPackage(modName)
}

withSdk() 🔗

Generate the SDK into the container.

Return Type 
ElixirSdk !
Arguments
NameTypeDefault ValueDescription
introspectionJsonFile !-No description provided
Example
dagger -m github.com/dagger/dagger/sdk/elixir@d3a02170c96d4d81343dbbcd5c555ba6b8d38b45 call \
 with-sdk --introspection-json file:path
func (m *myModule) example(introspectionJson *File) *ElixirSdk  {
	return dag.
			ElixirSdk().
			WithSdk(introspectionJson)
}
@function
def example(introspection_json: dagger.File) -> dag.ElixirSdk:
	return (
		dag.elixir_sdk()
		.with_sdk(introspection_json)
	)
@func()
example(introspectionJson: File): ElixirSdk {
	return dag
		.elixirSdk()
		.withSdk(introspectionJson)
}

withDaggerCodegen() 🔗

Return Type 
Container !
Example
dagger -m github.com/dagger/dagger/sdk/elixir@d3a02170c96d4d81343dbbcd5c555ba6b8d38b45 call \
 with-dagger-codegen
func (m *myModule) example() *Container  {
	return dag.
			ElixirSdk().
			WithDaggerCodegen()
}
@function
def example() -> dagger.Container:
	return (
		dag.elixir_sdk()
		.with_dagger_codegen()
	)
@func()
example(): Container {
	return dag
		.elixirSdk()
		.withDaggerCodegen()
}

generateCode() 🔗

Return Type 
Directory !
Arguments
NameTypeDefault ValueDescription
introspectionJsonFile !-No description provided
Example
dagger -m github.com/dagger/dagger/sdk/elixir@d3a02170c96d4d81343dbbcd5c555ba6b8d38b45 call \
 generate-code --introspection-json file:path
func (m *myModule) example(introspectionJson *File) *Directory  {
	return dag.
			ElixirSdk().
			GenerateCode(introspectionJson)
}
@function
def example(introspection_json: dagger.File) -> dagger.Directory:
	return (
		dag.elixir_sdk()
		.generate_code(introspection_json)
	)
@func()
example(introspectionJson: File): Directory {
	return dag
		.elixirSdk()
		.generateCode(introspectionJson)
}