typescript-sdk-dev

Toolchain to develop the Dagger Typescript SDK

Installation

dagger install github.com/shykes/dagger/toolchains/typescript-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe

Entrypoint

Return Type

TypescriptSdkDev !

Arguments

Name	Type	Default Value	Description
nodeVersionPrevLts	String	-	No description provided
nodeVersionLts	String	-	No description provided
bunVersion	String	-	No description provided
workspace	Directory	-	No description provided
sourcePath	String	-	No description provided

Example

dagger -m github.com/shykes/dagger/toolchains/typescript-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \

func (m *MyModule) Example() *dagger.TypescriptSdkDev  {
	return dag.
			TypescriptSdkDev()
}

@function
def example() -> dagger.TypescriptSdkDev:
	return (
		dag.typescript_sdk_dev()
	)

@func()
example(): TypescriptSdkDev {
	return dag
		.typescriptSdkDev()
}

Types

TypescriptSdkDev 🔗

nodeVersionLts() 🔗

Return Type

String !

Example

dagger -m github.com/shykes/dagger/toolchains/typescript-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 node-version-lts

func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			TypescriptSdkDev().
			NodeVersionLts(ctx)
}

@function
async def example() -> str:
	return await (
		dag.typescript_sdk_dev()
		.node_version_lts()
	)

@func()
async example(): Promise<string> {
	return dag
		.typescriptSdkDev()
		.nodeVersionLts()
}

nodeVersionPrevLts() 🔗

Return Type

String !

Example

dagger -m github.com/shykes/dagger/toolchains/typescript-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 node-version-prev-lts

func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			TypescriptSdkDev().
			NodeVersionPrevLts(ctx)
}

@function
async def example() -> str:
	return await (
		dag.typescript_sdk_dev()
		.node_version_prev_lts()
	)

@func()
async example(): Promise<string> {
	return dag
		.typescriptSdkDev()
		.nodeVersionPrevLts()
}

bunVersion() 🔗

Return Type

String !

Example

dagger -m github.com/shykes/dagger/toolchains/typescript-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 bun-version

func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			TypescriptSdkDev().
			BunVersion(ctx)
}

@function
async def example() -> str:
	return await (
		dag.typescript_sdk_dev()
		.bun_version()
	)

@func()
async example(): Promise<string> {
	return dag
		.typescriptSdkDev()
		.bunVersion()
}

workspace() 🔗

Return Type

Directory !

Example

dagger -m github.com/shykes/dagger/toolchains/typescript-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 workspace

func (m *MyModule) Example() *dagger.Directory  {
	return dag.
			TypescriptSdkDev().
			Workspace()
}

@function
def example() -> dagger.Directory:
	return (
		dag.typescript_sdk_dev()
		.workspace()
	)

@func()
example(): Directory {
	return dag
		.typescriptSdkDev()
		.workspace()
}

sourcePath() 🔗

Return Type

String !

Example

dagger -m github.com/shykes/dagger/toolchains/typescript-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 source-path

func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			TypescriptSdkDev().
			SourcePath(ctx)
}

@function
async def example() -> str:
	return await (
		dag.typescript_sdk_dev()
		.source_path()
	)

@func()
async example(): Promise<string> {
	return dag
		.typescriptSdkDev()
		.sourcePath()
}

bump() 🔗

Bump the Typescript SDK’s engine dependency

Return Type

Changeset !

Arguments

Name	Type	Default Value	Description
version	String !	-	No description provided

Example

dagger -m github.com/shykes/dagger/toolchains/typescript-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 bump --version string

func (m *MyModule) Example(version string) *dagger.Changeset  {
	return dag.
			TypescriptSdkDev().
			Bump(version)
}

@function
def example(version: str) -> dagger.Changeset:
	return (
		dag.typescript_sdk_dev()
		.bump(version)
	)

@func()
example(version: string): Changeset {
	return dag
		.typescriptSdkDev()
		.bump(version)
}

binary() 🔗

Return Type

File !

Example

dagger -m github.com/shykes/dagger/toolchains/typescript-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 binary

func (m *MyModule) Example() *dagger.File  {
	return dag.
			TypescriptSdkDev().
			Binary()
}

@function
def example() -> dagger.File:
	return (
		dag.typescript_sdk_dev()
		.binary()
	)

@func()
example(): File {
	return dag
		.typescriptSdkDev()
		.binary()
}

testNodejsPrevLts() 🔗

Test the SDK with previous LTS version of Node

Return Type

Void !

Example

dagger -m github.com/shykes/dagger/toolchains/typescript-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 test-nodejs-prev-lts

func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			TypescriptSdkDev().
			TestNodejsPrevLts(ctx)
}

@function
async def example() -> None:
	return await (
		dag.typescript_sdk_dev()
		.test_nodejs_prev_lts()
	)

@func()
async example(): Promise<void> {
	return dag
		.typescriptSdkDev()
		.testNodejsPrevLts()
}

testBunjs() 🔗

Test the SDK with BunJS

Return Type

Void !

Example

dagger -m github.com/shykes/dagger/toolchains/typescript-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 test-bunjs

func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			TypescriptSdkDev().
			TestBunjs(ctx)
}

@function
async def example() -> None:
	return await (
		dag.typescript_sdk_dev()
		.test_bunjs()
	)

@func()
async example(): Promise<void> {
	return dag
		.typescriptSdkDev()
		.testBunjs()
}

release() 🔗

Return Type

Void !

Arguments

Name	Type	Default Value	Description
sourceTag	String !	-	No description provided
npmToken	Secret !	-	No description provided
dryRun	Boolean	-	No description provided

Example

dagger -m github.com/shykes/dagger/toolchains/typescript-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 release --source-tag string --npm-token env:MYSECRET

func (m *MyModule) Example(ctx context.Context, sourceTag string, npmToken *dagger.Secret)   {
	return dag.
			TypescriptSdkDev().
			Release(ctx, sourceTag, npmToken)
}

@function
async def example(source_tag: str, npm_token: dagger.Secret) -> None:
	return await (
		dag.typescript_sdk_dev()
		.release(source_tag, npm_token)
	)

@func()
async example(sourceTag: string, npmToken: Secret): Promise<void> {
	return dag
		.typescriptSdkDev()
		.release(sourceTag, npmToken)
}

nodejsBase() 🔗

Return Type

Container !

Arguments

Name	Type	Default Value	Description
nodeVersion	String	-	No description provided

Example

dagger -m github.com/shykes/dagger/toolchains/typescript-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 nodejs-base

func (m *MyModule) Example() *dagger.Container  {
	return dag.
			TypescriptSdkDev().
			NodejsBase()
}

@function
def example() -> dagger.Container:
	return (
		dag.typescript_sdk_dev()
		.nodejs_base()
	)

@func()
example(): Container {
	return dag
		.typescriptSdkDev()
		.nodejsBase()
}

testNodejsLts() 🔗

Test the SDK with LTS version of Node

Return Type

Void !

Example

dagger -m github.com/shykes/dagger/toolchains/typescript-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 test-nodejs-lts

func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			TypescriptSdkDev().
			TestNodejsLts(ctx)
}

@function
async def example() -> None:
	return await (
		dag.typescript_sdk_dev()
		.test_nodejs_lts()
	)

@func()
async example(): Promise<void> {
	return dag
		.typescriptSdkDev()
		.testNodejsLts()
}

testNodejs() 🔗

Test the SDK with the given version of NodeJS

Return Type

Void !

Arguments

Name	Type	Default Value	Description
nodeVersion	String !	-	No description provided

Example

dagger -m github.com/shykes/dagger/toolchains/typescript-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 test-nodejs --node-version string

func (m *MyModule) Example(ctx context.Context, nodeVersion string)   {
	return dag.
			TypescriptSdkDev().
			TestNodejs(ctx, nodeVersion)
}

@function
async def example(node_version: str) -> None:
	return await (
		dag.typescript_sdk_dev()
		.test_nodejs(node_version)
	)

@func()
async example(nodeVersion: string): Promise<void> {
	return dag
		.typescriptSdkDev()
		.testNodejs(nodeVersion)
}

releaseDryRun() 🔗

Return Type

Void !

Example

dagger -m github.com/shykes/dagger/toolchains/typescript-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 release-dry-run

func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			TypescriptSdkDev().
			ReleaseDryRun(ctx)
}

@function
async def example() -> None:
	return await (
		dag.typescript_sdk_dev()
		.release_dry_run()
	)

@func()
async example(): Promise<void> {
	return dag
		.typescriptSdkDev()
		.releaseDryRun()
}

nodejsDevContainer() 🔗

Return Type

Container !

Arguments

Name	Type	Default Value	Description
nodeVersion	String	-	No description provided

Example

dagger -m github.com/shykes/dagger/toolchains/typescript-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 nodejs-dev-container

func (m *MyModule) Example() *dagger.Container  {
	return dag.
			TypescriptSdkDev().
			NodejsDevContainer()
}

@function
def example() -> dagger.Container:
	return (
		dag.typescript_sdk_dev()
		.nodejs_dev_container()
	)

@func()
example(): Container {
	return dag
		.typescriptSdkDev()
		.nodejsDevContainer()
}

lintTypescript() 🔗

Check the formatting of the SDK

Return Type

Void !

Example

dagger -m github.com/shykes/dagger/toolchains/typescript-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 lint-typescript

func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			TypescriptSdkDev().
			LintTypescript(ctx)
}

@function
async def example() -> None:
	return await (
		dag.typescript_sdk_dev()
		.lint_typescript()
	)

@func()
async example(): Promise<void> {
	return dag
		.typescriptSdkDev()
		.lintTypescript()
}

isSemver() 🔗

Return Type

Boolean !

Arguments

Name	Type	Default Value	Description
version	String !	-	No description provided

Example

dagger -m github.com/shykes/dagger/toolchains/typescript-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 is-semver --version string

func (m *MyModule) Example(ctx context.Context, version string) bool  {
	return dag.
			TypescriptSdkDev().
			IsSemver(ctx, version)
}

@function
async def example(version: str) -> bool:
	return await (
		dag.typescript_sdk_dev()
		.is_semver(version)
	)

@func()
async example(version: string): Promise<boolean> {
	return dag
		.typescriptSdkDev()
		.isSemver(version)
}

bunjsDevContainer() 🔗

Return Type

Container !

Example

dagger -m github.com/shykes/dagger/toolchains/typescript-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 bunjs-dev-container

func (m *MyModule) Example() *dagger.Container  {
	return dag.
			TypescriptSdkDev().
			BunjsDevContainer()
}

@function
def example() -> dagger.Container:
	return (
		dag.typescript_sdk_dev()
		.bunjs_dev_container()
	)

@func()
example(): Container {
	return dag
		.typescriptSdkDev()
		.bunjsDevContainer()
}

source() 🔗

Return Type

Directory !

Example

dagger -m github.com/shykes/dagger/toolchains/typescript-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 source

func (m *MyModule) Example() *dagger.Directory  {
	return dag.
			TypescriptSdkDev().
			Source()
}

@function
def example() -> dagger.Directory:
	return (
		dag.typescript_sdk_dev()
		.source()
	)

@func()
example(): Directory {
	return dag
		.typescriptSdkDev()
		.source()
}

lintDocsSnippets() 🔗

Check the formatting of Typescript docs snippets

Return Type

Void !

Arguments

Name	Type	Default Value	Description
docsWorkspace	Directory	-	No description provided

Example

dagger -m github.com/shykes/dagger/toolchains/typescript-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 lint-docs-snippets

func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			TypescriptSdkDev().
			LintDocsSnippets(ctx)
}

@function
async def example() -> None:
	return await (
		dag.typescript_sdk_dev()
		.lint_docs_snippets()
	)

@func()
async example(): Promise<void> {
	return dag
		.typescriptSdkDev()
		.lintDocsSnippets()
}

generate() 🔗

Generate the Typescript client library

Return Type

Changeset !

Example

dagger -m github.com/shykes/dagger/toolchains/typescript-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 generate

func (m *MyModule) Example() *dagger.Changeset  {
	return dag.
			TypescriptSdkDev().
			Generate()
}

@function
def example() -> dagger.Changeset:
	return (
		dag.typescript_sdk_dev()
		.generate()
	)

@func()
example(): Changeset {
	return dag
		.typescriptSdkDev()
		.generate()
}