Dagger
Search

e2e

No long description provided.

Installation

dagger install github.com/dagger/typescript-sdk/.dagger/modules/e2e@ef2076a026584b4c56c656db2ee91bb4ea5c3ad0

Entrypoint

Return Type 
E2E !
Example
dagger -m github.com/dagger/typescript-sdk/.dagger/modules/e2e@ef2076a026584b4c56c656db2ee91bb4ea5c3ad0 call \

func (m *MyModule) Example() *dagger.E2E  {
	return dag.
			E2e()
}
@function
def example() -> dagger.E2E:
	return (
		dag.e2e()
	)
@func()
example(): E2E {
	return dag
		.e2e()
}

Types

E2E 🔗

End-to-end checks for the TypeScript SDK helper module.

skipGenerateFilenameCheck() 🔗

The helper should expose the generate skip marker used by callers.

Return Type 
Void !
Example
dagger -m github.com/dagger/typescript-sdk/.dagger/modules/e2e@ef2076a026584b4c56c656db2ee91bb4ea5c3ad0 call \
 skip-generate-filename-check
func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			E2e().
			SkipGenerateFilenameCheck(ctx)
}
@function
async def example() -> None:
	return await (
		dag.e2e()
		.skip_generate_filename_check()
	)
@func()
async example(): Promise<void> {
	return dag
		.e2e()
		.skipGenerateFilenameCheck()
}

moduleLookupCheck() 🔗

Mod lookup should find the owning TypeScript SDK module when called from a nested path.

Return Type 
Void !
Arguments
NameTypeDefault ValueDescription
wsWorkspace -No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			E2e().
			ModuleLookupCheck(ctx)
}
@function
async def example() -> None:
	return await (
		dag.e2e()
		.module_lookup_check()
	)
@func()
async example(): Promise<void> {
	return dag
		.e2e()
		.moduleLookupCheck()
}

initCheck() 🔗

Init should produce only the seed files and the requested generated-file policy.

Return Type 
Void !
Arguments
NameTypeDefault ValueDescription
wsWorkspace -No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			E2e().
			InitCheck(ctx)
}
@function
async def example() -> None:
	return await (
		dag.e2e()
		.init_check()
	)
@func()
async example(): Promise<void> {
	return dag
		.e2e()
		.initCheck()
}

initRespectsExistingCheck() 🔗

Init against a path that already contains user-authored package.json, tsconfig.json, or deno.json should merge Dagger-required keys into those files instead of clobbering them.

Return Type 
Void !
Arguments
NameTypeDefault ValueDescription
wsWorkspace -No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			E2e().
			InitRespectsExistingCheck(ctx)
}
@function
async def example() -> None:
	return await (
		dag.e2e()
		.init_respects_existing_check()
	)
@func()
async example(): Promise<void> {
	return dag
		.e2e()
		.initRespectsExistingCheck()
}

generateCheck() 🔗

Generating an existing module should produce generated files rooted at that module without touching unrelated paths.

Return Type 
Void !
Arguments
NameTypeDefault ValueDescription
wsWorkspace -No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			E2e().
			GenerateCheck(ctx)
}
@function
async def example() -> None:
	return await (
		dag.e2e()
		.generate_check()
	)
@func()
async example(): Promise<void> {
	return dag
		.e2e()
		.generateCheck()
}

generateAllCheck() 🔗

Generating all modules should discover TypeScript SDK modules and ignore skipped ones.

Return Type 
Void !
Arguments
NameTypeDefault ValueDescription
wsWorkspace -No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			E2e().
			GenerateAllCheck(ctx)
}
@function
async def example() -> None:
	return await (
		dag.e2e()
		.generate_all_check()
	)
@func()
async example(): Promise<void> {
	return dag
		.e2e()
		.generateAllCheck()
}

skipGenerateCheck() 🔗

A skip marker above a module should make generate return an empty changeset.

Return Type 
Void !
Arguments
NameTypeDefault ValueDescription
wsWorkspace -No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			E2e().
			SkipGenerateCheck(ctx)
}
@function
async def example() -> None:
	return await (
		dag.e2e()
		.skip_generate_check()
	)
@func()
async example(): Promise<void> {
	return dag
		.e2e()
		.skipGenerateCheck()
}

engineVersionCheck() 🔗

Engine version helpers should read dagger.json and write normalized versions.

Return Type 
Void !
Arguments
NameTypeDefault ValueDescription
wsWorkspace -No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			E2e().
			EngineVersionCheck(ctx)
}
@function
async def example() -> None:
	return await (
		dag.e2e()
		.engine_version_check()
	)
@func()
async example(): Promise<void> {
	return dag
		.e2e()
		.engineVersionCheck()
}

dependencyListCheck() 🔗

Dependency listing should preserve how users identify dependencies: string entries return their source, named object entries return their name.

Return Type 
Void !
Arguments
NameTypeDefault ValueDescription
wsWorkspace -No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			E2e().
			DependencyListCheck(ctx)
}
@function
async def example() -> None:
	return await (
		dag.e2e()
		.dependency_list_check()
	)
@func()
async example(): Promise<void> {
	return dag
		.e2e()
		.dependencyListCheck()
}

dependencyEditCheck() 🔗

Dependency edits should update only dagger.json. Users run generate separately when they want generated SDK files refreshed.

Return Type 
Void !
Arguments
NameTypeDefault ValueDescription
wsWorkspace -No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			E2e().
			DependencyEditCheck(ctx)
}
@function
async def example() -> None:
	return await (
		dag.e2e()
		.dependency_edit_check()
	)
@func()
async example(): Promise<void> {
	return dag
		.e2e()
		.dependencyEditCheck()
}

configCheck() 🔗

Config readers should reflect package.json (or deno.json), and mutators should edit only the targeted config file while preserving unrelated keys.

Return Type 
Void !
Arguments
NameTypeDefault ValueDescription
wsWorkspace -No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			E2e().
			ConfigCheck(ctx)
}
@function
async def example() -> None:
	return await (
		dag.e2e()
		.config_check()
	)
@func()
async example(): Promise<void> {
	return dag
		.e2e()
		.configCheck()
}

initConfigCheck() 🔗

Init flags should write configuration into the generated config files. By default, no config keys are written; the runtime decides which file the base image override lands in.

Return Type 
Void !
Arguments
NameTypeDefault ValueDescription
wsWorkspace -No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			E2e().
			InitConfigCheck(ctx)
}
@function
async def example() -> None:
	return await (
		dag.e2e()
		.init_config_check()
	)
@func()
async example(): Promise<void> {
	return dag
		.e2e()
		.initConfigCheck()
}

modulesCheck() 🔗

Listing modules in a workspace should return every module whose dagger.json declares the TypeScript SDK, and nothing else.

Return Type 
Void !
Arguments
NameTypeDefault ValueDescription
wsWorkspace -No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			E2e().
			ModulesCheck(ctx)
}
@function
async def example() -> None:
	return await (
		dag.e2e()
		.modules_check()
	)
@func()
async example(): Promise<void> {
	return dag
		.e2e()
		.modulesCheck()
}