Dagger
Search

moduleHelper

This module has been generated via dagger init and serves as a reference to
basic module structure as you get started with Dagger.

Two functions have been pre-created. You can modify, delete, or add to them,
as needed. They demonstrate usage of arguments and return types using simple
echo and grep commands. The functions can be called from the dagger CLI or
from one of the SDKs.

The first line in this comment block is a short description line and the
rest is a long description with more detail on the module's purpose or usage,
if appropriate. All modules should have a short description.

Installation

dagger install github.com/kpenfound/dagger-programmer/moduleHelper@df1ced09304c4a18a20bc226b7c783293e74be84

Entrypoint

Return Type 
ModuleHelper !
Example
dagger -m github.com/kpenfound/dagger-programmer/moduleHelper@df1ced09304c4a18a20bc226b7c783293e74be84 call \

func (m *myModule) example() *dagger.ModuleHelper  {
	return dag.
			ModuleHelper()
}
@function
def example() -> dagger.ModuleHelper:
	return (
		dag.module_helper()
	)
@func()
example(): ModuleHelper {
	return dag
		.moduleHelper()
}

Types

ModuleHelper 🔗

getModuleSchema() 🔗

Get the schema of a module represented as an XML string

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
modModule !-A Dagger module.
Example
echo 'Custom types are not supported in shell examples'
func (m *myModule) example(ctx context.Context, mod *dagger.Module) string  {
	return dag.
			ModuleHelper().
			GetModuleSchema(ctx, mod)
}
@function
async def example(mod: dagger.Module) -> str:
	return await (
		dag.module_helper()
		.get_module_schema(mod)
	)
@func()
async example(mod: Module): Promise<string> {
	return dag
		.moduleHelper()
		.getModuleSchema(mod)
}

getSdkMainFile() 🔗

Get the main SDK file path for the given module name and SDK

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
sdkString !-No description provided
nameString !-No description provided
Example
dagger -m github.com/kpenfound/dagger-programmer/moduleHelper@df1ced09304c4a18a20bc226b7c783293e74be84 call \
 get-sdk-main-file --sdk string --name string
func (m *myModule) example(ctx context.Context, sdk string, name string) string  {
	return dag.
			ModuleHelper().
			GetSdkMainFile(ctx, sdk, name)
}
@function
async def example(sdk: str, name: str) -> str:
	return await (
		dag.module_helper()
		.get_sdk_main_file(sdk, name)
	)
@func()
async example(sdk: string, name: string): Promise<string> {
	return dag
		.moduleHelper()
		.getSdkMainFile(sdk, name)
}

getTypeName() 🔗

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
typeTypeDef !-A definition of a parameter or return type in a Module.
Example
echo 'Custom types are not supported in shell examples'
func (m *myModule) example(ctx context.Context, type *dagger.TypeDef) string  {
	return dag.
			ModuleHelper().
			GetTypeName(ctx, type)
}
@function
async def example(type: dagger.TypeDef) -> str:
	return await (
		dag.module_helper()
		.get_type_name(type)
	)
@func()
async example(type: TypeDef): Promise<string> {
	return dag
		.moduleHelper()
		.getTypeName(type)
}