Dagger
Search

timpkg

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/anthonybrice/timpkg@3ea4fac61cb0a744e9e279658b049e2c49d7257a

Entrypoint

Return Type 
Timpkg
Example
func (m *myModule) example() *Timpkg  {
	return dag.
			Timpkg()
}
@function
def example() -> dag.Timpkg:
	return (
		dag.timpkg()
	)
@func()
example(): Timpkg {
	return dag
		.timpkg()
}

Types

Timpkg 🔗

containerEcho() 🔗

Returns a container that echoes whatever string argument is provided

Return Type 
Container !
Arguments
NameTypeDefault ValueDescription
stringArgString !-No description provided
Example
dagger -m github.com/anthonybrice/timpkg@3ea4fac61cb0a744e9e279658b049e2c49d7257a call \
 container-echo --string-arg string
func (m *myModule) example(stringArg string) *Container  {
	return dag.
			Timpkg().
			ContainerEcho(stringArg)
}
@function
def example(string_arg: str) -> dagger.Container:
	return (
		dag.timpkg()
		.container_echo(string_arg)
	)
@func()
example(stringArg: string): Container {
	return dag
		.timpkg()
		.containerEcho(stringArg)
}

grepDir() 🔗

Returns lines that match a pattern in the files of the provided Directory

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
directoryArgDirectory !-No description provided
patternString !-No description provided
Example
dagger -m github.com/anthonybrice/timpkg@3ea4fac61cb0a744e9e279658b049e2c49d7257a call \
 grep-dir --directory-arg DIR_PATH --pattern string
func (m *myModule) example(ctx context.Context, directoryArg *Directory, pattern string) string  {
	return dag.
			Timpkg().
			GrepDir(ctx, directoryArg, pattern)
}
@function
async def example(directory_arg: dagger.Directory, pattern: str) -> str:
	return await (
		dag.timpkg()
		.grep_dir(directory_arg, pattern)
	)
@func()
async example(directoryArg: Directory, pattern: string): Promise<string> {
	return dag
		.timpkg()
		.grepDir(directoryArg, pattern)
}

onPush() 🔗

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
dirDirectory !-No description provided
commitJsonString !-No description provided
Example
dagger -m github.com/anthonybrice/timpkg@3ea4fac61cb0a744e9e279658b049e2c49d7257a call \
 on-push --dir DIR_PATH --commit-json string
func (m *myModule) example(ctx context.Context, dir *Directory, commitJson string) string  {
	return dag.
			Timpkg().
			OnPush(ctx, dir, commitJson)
}
@function
async def example(dir: dagger.Directory, commit_json: str) -> str:
	return await (
		dag.timpkg()
		.on_push(dir, commit_json)
	)
@func()
async example(dir: Directory, commitJson: string): Promise<string> {
	return dag
		.timpkg()
		.onPush(dir, commitJson)
}