npm

No long description provided.

Installation

dagger install github.com/BasisTI/daggerverse/npm@98994f07b1dd76282dd1f3fdc59cfef6c646bf5d

Entrypoint

Return Type

Npm !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	Directory with node/npm source code
buildImage	String !	"node:22.16.0-alpine3.22"	BuildImage name for building application
runImage	String !	"nginx:1.27.3-alpine-slim"	BuildImage name for building application
useCache	Boolean !	true	Use Npm Cache

Example

dagger -m github.com/BasisTI/daggerverse/npm@98994f07b1dd76282dd1f3fdc59cfef6c646bf5d call \
 --source DIR_PATH --build-image string --run-image string --use-cache boolean

func (m *MyModule) Example(source *dagger.Directory, buildImage string, runImage string, useCache bool) *dagger.Npm  {
	return dag.
			Npm(source, buildImage, runImage, useCache)
}

@function
def example(source: dagger.Directory, build_image: str, run_image: str, use_cache: bool) -> dagger.Npm:
	return (
		dag.npm(source, build_image, run_image, use_cache)
	)

@func()
example(source: Directory, buildImage: string, runImage: string, useCache: boolean): Npm {
	return dag
		.npm(source, buildImage, runImage, useCache)
}

Types

Npm 🔗

Npm represents an npm project and provides helpers to run common build steps inside a Dagger container.

buildImage() 🔗

Return Type

String !

Example

dagger -m github.com/BasisTI/daggerverse/npm@98994f07b1dd76282dd1f3fdc59cfef6c646bf5d call \
 --source DIR_PATH --build-image string --run-image string --use-cache boolean build-image

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory, buildImage string, runImage string, useCache bool) string  {
	return dag.
			Npm(source, buildImage, runImage, useCache).
			BuildImage(ctx)
}

@function
async def example(source: dagger.Directory, build_image: str, run_image: str, use_cache: bool) -> str:
	return await (
		dag.npm(source, build_image, run_image, use_cache)
		.build_image()
	)

@func()
async example(source: Directory, buildImage: string, runImage: string, useCache: boolean): Promise<string> {
	return dag
		.npm(source, buildImage, runImage, useCache)
		.buildImage()
}

runImage() 🔗

Return Type

String !

Example

dagger -m github.com/BasisTI/daggerverse/npm@98994f07b1dd76282dd1f3fdc59cfef6c646bf5d call \
 --source DIR_PATH --build-image string --run-image string --use-cache boolean run-image

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory, buildImage string, runImage string, useCache bool) string  {
	return dag.
			Npm(source, buildImage, runImage, useCache).
			RunImage(ctx)
}

@function
async def example(source: dagger.Directory, build_image: str, run_image: str, use_cache: bool) -> str:
	return await (
		dag.npm(source, build_image, run_image, use_cache)
		.run_image()
	)

@func()
async example(source: Directory, buildImage: string, runImage: string, useCache: boolean): Promise<string> {
	return dag
		.npm(source, buildImage, runImage, useCache)
		.runImage()
}

useCache() 🔗

Return Type

Boolean !

Example

dagger -m github.com/BasisTI/daggerverse/npm@98994f07b1dd76282dd1f3fdc59cfef6c646bf5d call \
 --source DIR_PATH --build-image string --run-image string --use-cache boolean use-cache

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory, buildImage string, runImage string, useCache bool) bool  {
	return dag.
			Npm(source, buildImage, runImage, useCache).
			UseCache(ctx)
}

@function
async def example(source: dagger.Directory, build_image: str, run_image: str, use_cache: bool) -> bool:
	return await (
		dag.npm(source, build_image, run_image, use_cache)
		.use_cache()
	)

@func()
async example(source: Directory, buildImage: string, runImage: string, useCache: boolean): Promise<boolean> {
	return dag
		.npm(source, buildImage, runImage, useCache)
		.useCache()
}

source() 🔗

Return Type

Directory !

Example

dagger -m github.com/BasisTI/daggerverse/npm@98994f07b1dd76282dd1f3fdc59cfef6c646bf5d call \
 --source DIR_PATH --build-image string --run-image string --use-cache boolean source

func (m *MyModule) Example(source *dagger.Directory, buildImage string, runImage string, useCache bool) *dagger.Directory  {
	return dag.
			Npm(source, buildImage, runImage, useCache).
			Source()
}

@function
def example(source: dagger.Directory, build_image: str, run_image: str, use_cache: bool) -> dagger.Directory:
	return (
		dag.npm(source, build_image, run_image, use_cache)
		.source()
	)

@func()
example(source: Directory, buildImage: string, runImage: string, useCache: boolean): Directory {
	return dag
		.npm(source, buildImage, runImage, useCache)
		.source()
}

nodeContainer() 🔗

Return Type

Container !

Example

dagger -m github.com/BasisTI/daggerverse/npm@98994f07b1dd76282dd1f3fdc59cfef6c646bf5d call \
 --source DIR_PATH --build-image string --run-image string --use-cache boolean node-container

func (m *MyModule) Example(source *dagger.Directory, buildImage string, runImage string, useCache bool) *dagger.Container  {
	return dag.
			Npm(source, buildImage, runImage, useCache).
			NodeContainer()
}

@function
def example(source: dagger.Directory, build_image: str, run_image: str, use_cache: bool) -> dagger.Container:
	return (
		dag.npm(source, build_image, run_image, use_cache)
		.node_container()
	)

@func()
example(source: Directory, buildImage: string, runImage: string, useCache: boolean): Container {
	return dag
		.npm(source, buildImage, runImage, useCache)
		.nodeContainer()
}

newDockerBuildConfig() 🔗

NewDockerBuildConfig returns a DockerBuildConfig initialised with registry metadata and credentials.

Return Type

DockerBuildConfig !

Arguments

Name	Type	Default Value	Description
registry	String !	-	No description provided
group	String !	-	No description provided
image	String !	-	No description provided
username	String !	-	No description provided
passwordSecret	Secret !	-	No description provided

Example

dagger -m github.com/BasisTI/daggerverse/npm@98994f07b1dd76282dd1f3fdc59cfef6c646bf5d call \
 --source DIR_PATH --build-image string --run-image string --use-cache boolean new-docker-build-config --registry string --group string --image string --username string --password-secret env:MYSECRET

func (m *MyModule) Example(source *dagger.Directory, buildImage string, runImage string, useCache bool, registry string, group string, image string, username string, passwordSecret *dagger.Secret) *dagger.NpmDockerBuildConfig  {
	return dag.
			Npm(source, buildImage, runImage, useCache).
			NewDockerBuildConfig(registry, group, image, username, passwordSecret)
}

@function
def example(source: dagger.Directory, build_image: str, run_image: str, use_cache: bool, registry: str, group: str, image: str, username: str, password_secret: dagger.Secret) -> dagger.NpmDockerBuildConfig:
	return (
		dag.npm(source, build_image, run_image, use_cache)
		.new_docker_build_config(registry, group, image, username, password_secret)
	)

@func()
example(source: Directory, buildImage: string, runImage: string, useCache: boolean, registry: string, group: string, image: string, username: string, passwordSecret: Secret): NpmDockerBuildConfig {
	return dag
		.npm(source, buildImage, runImage, useCache)
		.newDockerBuildConfig(registry, group, image, username, passwordSecret)
}

newSonarConfig() 🔗

NewSonarConfig validates the provided inputs and returns an npm-specific Sonar configuration.

Return Type

SonarConfig !

Arguments

Name	Type	Default Value	Description
host	String !	-	No description provided
tokenSecret	Secret !	-	No description provided
projectKey	String !	-	No description provided
waitForQualityGate	Boolean !	true	No description provided
extraOptions	[String ! ]	-	No description provided
image	String !	"sonarsource/sonar-scanner-cli:11.4.0.2044_7.2.0"	No description provided

Example

dagger -m github.com/BasisTI/daggerverse/npm@98994f07b1dd76282dd1f3fdc59cfef6c646bf5d call \
 --source DIR_PATH --build-image string --run-image string --use-cache boolean new-sonar-config --host string --token-secret env:MYSECRET --project-key string --wait-for-quality-gate boolean --image string

func (m *MyModule) Example(source *dagger.Directory, buildImage string, runImage string, useCache bool, host string, tokenSecret *dagger.Secret, projectKey string, waitForQualityGate bool, image string) *dagger.NpmSonarConfig  {
	return dag.
			Npm(source, buildImage, runImage, useCache).
			NewSonarConfig(host, tokenSecret, projectKey, waitForQualityGate, image)
}

@function
def example(source: dagger.Directory, build_image: str, run_image: str, use_cache: bool, host: str, token_secret: dagger.Secret, project_key: str, wait_for_quality_gate: bool, image: str) -> dagger.NpmSonarConfig:
	return (
		dag.npm(source, build_image, run_image, use_cache)
		.new_sonar_config(host, token_secret, project_key, wait_for_quality_gate, image)
	)

@func()
example(source: Directory, buildImage: string, runImage: string, useCache: boolean, host: string, tokenSecret: Secret, projectKey: string, waitForQualityGate: boolean, image: string): NpmSonarConfig {
	return dag
		.npm(source, buildImage, runImage, useCache)
		.newSonarConfig(host, tokenSecret, projectKey, waitForQualityGate, image)
}

newContainer() 🔗

NewContainer creates a fresh container primed with the project source and optional cache.

Return Type

Container !

Example

dagger -m github.com/BasisTI/daggerverse/npm@98994f07b1dd76282dd1f3fdc59cfef6c646bf5d call \
 --source DIR_PATH --build-image string --run-image string --use-cache boolean new-container

func (m *MyModule) Example(source *dagger.Directory, buildImage string, runImage string, useCache bool) *dagger.Container  {
	return dag.
			Npm(source, buildImage, runImage, useCache).
			NewContainer()
}

@function
def example(source: dagger.Directory, build_image: str, run_image: str, use_cache: bool) -> dagger.Container:
	return (
		dag.npm(source, build_image, run_image, use_cache)
		.new_container()
	)

@func()
example(source: Directory, buildImage: string, runImage: string, useCache: boolean): Container {
	return dag
		.npm(source, buildImage, runImage, useCache)
		.newContainer()
}

container() 🔗

Container returns the memoised container, initialising it if needed.

Return Type

Container !

Example

dagger -m github.com/BasisTI/daggerverse/npm@98994f07b1dd76282dd1f3fdc59cfef6c646bf5d call \
 --source DIR_PATH --build-image string --run-image string --use-cache boolean container

func (m *MyModule) Example(source *dagger.Directory, buildImage string, runImage string, useCache bool) *dagger.Container  {
	return dag.
			Npm(source, buildImage, runImage, useCache).
			Container()
}

@function
def example(source: dagger.Directory, build_image: str, run_image: str, use_cache: bool) -> dagger.Container:
	return (
		dag.npm(source, build_image, run_image, use_cache)
		.container()
	)

@func()
example(source: Directory, buildImage: string, runImage: string, useCache: boolean): Container {
	return dag
		.npm(source, buildImage, runImage, useCache)
		.container()
}

getAngularDistDir() 🔗

GetAngularDistDir returns the Angular distribution directory produced by the build.

Return Type

Directory !

Example

dagger -m github.com/BasisTI/daggerverse/npm@98994f07b1dd76282dd1f3fdc59cfef6c646bf5d call \
 --source DIR_PATH --build-image string --run-image string --use-cache boolean get-angular-dist-dir

func (m *MyModule) Example(source *dagger.Directory, buildImage string, runImage string, useCache bool) *dagger.Directory  {
	return dag.
			Npm(source, buildImage, runImage, useCache).
			GetAngularDistDir()
}

@function
def example(source: dagger.Directory, build_image: str, run_image: str, use_cache: bool) -> dagger.Directory:
	return (
		dag.npm(source, build_image, run_image, use_cache)
		.get_angular_dist_dir()
	)

@func()
example(source: Directory, buildImage: string, runImage: string, useCache: boolean): Directory {
	return dag
		.npm(source, buildImage, runImage, useCache)
		.getAngularDistDir()
}

fullBuild() 🔗

FullBuild executes a typical npm pipeline: install dependencies, run tests, build assets, optional Sonar analysis, and image metadata preparation.

Return Type

BuildResult !

Arguments

Name	Type	Default Value	Description
commitSha	String	-	Git commit SHA for image labels
sonarConfig	SonarConfig	-	No description provided
dockerConfig	DockerBuildConfig	-	No description provided

Example

echo 'Custom types are not supported in shell examples'

func (m *MyModule) Example(source *dagger.Directory, buildImage string, runImage string, useCache bool) *dagger.NpmBuildResult  {
	return dag.
			Npm(source, buildImage, runImage, useCache).
			FullBuild()
}

@function
def example(source: dagger.Directory, build_image: str, run_image: str, use_cache: bool) -> dagger.NpmBuildResult:
	return (
		dag.npm(source, build_image, run_image, use_cache)
		.full_build()
	)

@func()
example(source: Directory, buildImage: string, runImage: string, useCache: boolean): NpmBuildResult {
	return dag
		.npm(source, buildImage, runImage, useCache)
		.fullBuild()
}

getVersion() 🔗

Return Type

String !

Example

dagger -m github.com/BasisTI/daggerverse/npm@98994f07b1dd76282dd1f3fdc59cfef6c646bf5d call \
 --source DIR_PATH --build-image string --run-image string --use-cache boolean get-version

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory, buildImage string, runImage string, useCache bool) string  {
	return dag.
			Npm(source, buildImage, runImage, useCache).
			GetVersion(ctx)
}

@function
async def example(source: dagger.Directory, build_image: str, run_image: str, use_cache: bool) -> str:
	return await (
		dag.npm(source, build_image, run_image, use_cache)
		.get_version()
	)

@func()
async example(source: Directory, buildImage: string, runImage: string, useCache: boolean): Promise<string> {
	return dag
		.npm(source, buildImage, runImage, useCache)
		.getVersion()
}

getVersionOrDefault() 🔗

Return Type

String !

Arguments

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

Example

dagger -m github.com/BasisTI/daggerverse/npm@98994f07b1dd76282dd1f3fdc59cfef6c646bf5d call \
 --source DIR_PATH --build-image string --run-image string --use-cache boolean get-version-or-default --default-version string

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory, buildImage string, runImage string, useCache bool, defaultVersion string) string  {
	return dag.
			Npm(source, buildImage, runImage, useCache).
			GetVersionOrDefault(ctx, defaultVersion)
}

@function
async def example(source: dagger.Directory, build_image: str, run_image: str, use_cache: bool, default_version: str) -> str:
	return await (
		dag.npm(source, build_image, run_image, use_cache)
		.get_version_or_default(default_version)
	)

@func()
async example(source: Directory, buildImage: string, runImage: string, useCache: boolean, defaultVersion: string): Promise<string> {
	return dag
		.npm(source, buildImage, runImage, useCache)
		.getVersionOrDefault(defaultVersion)
}

BuildResult 🔗

BuildResult aggregates the outcome of the npm pipeline for a single project.

artifacts() 🔗

Return Type

Directory !

Example

echo 'Custom types are not supported in shell examples'

func (m *MyModule) Example() *dagger.Directory  {
	return dag.
			Npm().
			FullBuild().
			Artifacts()
}

@function
def example() -> dagger.Directory:
	return (
		dag.npm()
		.full_build()
		.artifacts()
	)

@func()
example(): Directory {
	return dag
		.npm()
		.fullBuild()
		.artifacts()
}

container() 🔗

Return Type

Container !

Example

echo 'Custom types are not supported in shell examples'

func (m *MyModule) Example() *dagger.Container  {
	return dag.
			Npm().
			FullBuild().
			Container()
}

@function
def example() -> dagger.Container:
	return (
		dag.npm()
		.full_build()
		.container()
	)

@func()
example(): Container {
	return dag
		.npm()
		.fullBuild()
		.container()
}

imageUrl() 🔗

Return Type

String !

Example

echo 'Custom types are not supported in shell examples'

func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			Npm().
			FullBuild().
			ImageUrl(ctx)
}

@function
async def example() -> str:
	return await (
		dag.npm()
		.full_build()
		.image_url()
	)

@func()
async example(): Promise<string> {
	return dag
		.npm()
		.fullBuild()
		.imageUrl()
}

executedStages() 🔗

Return Type

[String ! ] !

Example

echo 'Custom types are not supported in shell examples'

func (m *MyModule) Example(ctx context.Context) []string  {
	return dag.
			Npm().
			FullBuild().
			ExecutedStages(ctx)
}

@function
async def example() -> List[str]:
	return await (
		dag.npm()
		.full_build()
		.executed_stages()
	)

@func()
async example(): Promise<string[]> {
	return dag
		.npm()
		.fullBuild()
		.executedStages()
}

stdout() 🔗

Return Type

[String ! ] !

Example

echo 'Custom types are not supported in shell examples'

func (m *MyModule) Example(ctx context.Context) []string  {
	return dag.
			Npm().
			FullBuild().
			Stdout(ctx)
}

@function
async def example() -> List[str]:
	return await (
		dag.npm()
		.full_build()
		.stdout()
	)

@func()
async example(): Promise<string[]> {
	return dag
		.npm()
		.fullBuild()
		.stdout()
}

stderr() 🔗

Return Type

[String ! ] !

Example

echo 'Custom types are not supported in shell examples'

func (m *MyModule) Example(ctx context.Context) []string  {
	return dag.
			Npm().
			FullBuild().
			Stderr(ctx)
}

@function
async def example() -> List[str]:
	return await (
		dag.npm()
		.full_build()
		.stderr()
	)

@func()
async example(): Promise<string[]> {
	return dag
		.npm()
		.fullBuild()
		.stderr()
}

DockerBuildConfig 🔗

DockerBuildConfig stores the data needed to construct an image reference and authenticate pushes.

registry() 🔗

Return Type

String !

Example

dagger -m github.com/BasisTI/daggerverse/npm@98994f07b1dd76282dd1f3fdc59cfef6c646bf5d call \
 new-docker-build-config --registry string --group string --image string --username string --password-secret env:MYSECRET \
 registry

func (m *MyModule) Example(ctx context.Context, registry string, group string, image string, username string, passwordSecret *dagger.Secret) string  {
	return dag.
			Npm().
			NewDockerBuildConfig(registry, group, image, username, passwordSecret).
			Registry(ctx)
}

@function
async def example(registry: str, group: str, image: str, username: str, password_secret: dagger.Secret) -> str:
	return await (
		dag.npm()
		.new_docker_build_config(registry, group, image, username, password_secret)
		.registry()
	)

@func()
async example(registry: string, group: string, image: string, username: string, passwordSecret: Secret): Promise<string> {
	return dag
		.npm()
		.newDockerBuildConfig(registry, group, image, username, passwordSecret)
		.registry()
}

group() 🔗

Return Type

String !

Example

dagger -m github.com/BasisTI/daggerverse/npm@98994f07b1dd76282dd1f3fdc59cfef6c646bf5d call \
 new-docker-build-config --registry string --group string --image string --username string --password-secret env:MYSECRET \
 group

func (m *MyModule) Example(ctx context.Context, registry string, group string, image string, username string, passwordSecret *dagger.Secret) string  {
	return dag.
			Npm().
			NewDockerBuildConfig(registry, group, image, username, passwordSecret).
			Group(ctx)
}

@function
async def example(registry: str, group: str, image: str, username: str, password_secret: dagger.Secret) -> str:
	return await (
		dag.npm()
		.new_docker_build_config(registry, group, image, username, password_secret)
		.group()
	)

@func()
async example(registry: string, group: string, image: string, username: string, passwordSecret: Secret): Promise<string> {
	return dag
		.npm()
		.newDockerBuildConfig(registry, group, image, username, passwordSecret)
		.group()
}

image() 🔗

Return Type

String !

Example

dagger -m github.com/BasisTI/daggerverse/npm@98994f07b1dd76282dd1f3fdc59cfef6c646bf5d call \
 new-docker-build-config --registry string --group string --image string --username string --password-secret env:MYSECRET \
 image

func (m *MyModule) Example(ctx context.Context, registry string, group string, image string, username string, passwordSecret *dagger.Secret) string  {
	return dag.
			Npm().
			NewDockerBuildConfig(registry, group, image, username, passwordSecret).
			Image(ctx)
}

@function
async def example(registry: str, group: str, image: str, username: str, password_secret: dagger.Secret) -> str:
	return await (
		dag.npm()
		.new_docker_build_config(registry, group, image, username, password_secret)
		.image()
	)

@func()
async example(registry: string, group: string, image: string, username: string, passwordSecret: Secret): Promise<string> {
	return dag
		.npm()
		.newDockerBuildConfig(registry, group, image, username, passwordSecret)
		.image()
}

tag() 🔗

Return Type

String !

Example

dagger -m github.com/BasisTI/daggerverse/npm@98994f07b1dd76282dd1f3fdc59cfef6c646bf5d call \
 new-docker-build-config --registry string --group string --image string --username string --password-secret env:MYSECRET \
 tag

func (m *MyModule) Example(ctx context.Context, registry string, group string, image string, username string, passwordSecret *dagger.Secret) string  {
	return dag.
			Npm().
			NewDockerBuildConfig(registry, group, image, username, passwordSecret).
			Tag(ctx)
}

@function
async def example(registry: str, group: str, image: str, username: str, password_secret: dagger.Secret) -> str:
	return await (
		dag.npm()
		.new_docker_build_config(registry, group, image, username, password_secret)
		.tag()
	)

@func()
async example(registry: string, group: string, image: string, username: string, passwordSecret: Secret): Promise<string> {
	return dag
		.npm()
		.newDockerBuildConfig(registry, group, image, username, passwordSecret)
		.tag()
}

username() 🔗

Return Type

String !

Example

dagger -m github.com/BasisTI/daggerverse/npm@98994f07b1dd76282dd1f3fdc59cfef6c646bf5d call \
 new-docker-build-config --registry string --group string --image string --username string --password-secret env:MYSECRET \
 username

func (m *MyModule) Example(ctx context.Context, registry string, group string, image string, username string, passwordSecret *dagger.Secret) string  {
	return dag.
			Npm().
			NewDockerBuildConfig(registry, group, image, username, passwordSecret).
			Username(ctx)
}

@function
async def example(registry: str, group: str, image: str, username: str, password_secret: dagger.Secret) -> str:
	return await (
		dag.npm()
		.new_docker_build_config(registry, group, image, username, password_secret)
		.username()
	)

@func()
async example(registry: string, group: string, image: string, username: string, passwordSecret: Secret): Promise<string> {
	return dag
		.npm()
		.newDockerBuildConfig(registry, group, image, username, passwordSecret)
		.username()
}

passwordSecret() 🔗

Return Type

Secret !

Example

dagger -m github.com/BasisTI/daggerverse/npm@98994f07b1dd76282dd1f3fdc59cfef6c646bf5d call \
 new-docker-build-config --registry string --group string --image string --username string --password-secret env:MYSECRET \
 password-secret

func (m *MyModule) Example(registry string, group string, image string, username string, passwordSecret *dagger.Secret) *dagger.Secret  {
	return dag.
			Npm().
			NewDockerBuildConfig(registry, group, image, username, passwordSecret).
			PasswordSecret()
}

@function
def example(registry: str, group: str, image: str, username: str, password_secret: dagger.Secret) -> dagger.Secret:
	return (
		dag.npm()
		.new_docker_build_config(registry, group, image, username, password_secret)
		.password_secret()
	)

@func()
example(registry: string, group: string, image: string, username: string, passwordSecret: Secret): Secret {
	return dag
		.npm()
		.newDockerBuildConfig(registry, group, image, username, passwordSecret)
		.passwordSecret()
}

options() 🔗

Return Type

[String ! ] !

Example

dagger -m github.com/BasisTI/daggerverse/npm@98994f07b1dd76282dd1f3fdc59cfef6c646bf5d call \
 new-docker-build-config --registry string --group string --image string --username string --password-secret env:MYSECRET \
 options

func (m *MyModule) Example(ctx context.Context, registry string, group string, image string, username string, passwordSecret *dagger.Secret) []string  {
	return dag.
			Npm().
			NewDockerBuildConfig(registry, group, image, username, passwordSecret).
			Options(ctx)
}

@function
async def example(registry: str, group: str, image: str, username: str, password_secret: dagger.Secret) -> List[str]:
	return await (
		dag.npm()
		.new_docker_build_config(registry, group, image, username, password_secret)
		.options()
	)

@func()
async example(registry: string, group: string, image: string, username: string, passwordSecret: Secret): Promise<string[]> {
	return dag
		.npm()
		.newDockerBuildConfig(registry, group, image, username, passwordSecret)
		.options()
}

SonarConfig 🔗

SonarConfig encapsulates the parameters required to run SonarQube analysis from npm.

host() 🔗

Return Type

String !

Example

dagger -m github.com/BasisTI/daggerverse/npm@98994f07b1dd76282dd1f3fdc59cfef6c646bf5d call \
 new-sonar-config --host string --token-secret env:MYSECRET --project-key string --wait-for-quality-gate boolean --image string \
 host

func (m *MyModule) Example(ctx context.Context, host string, tokenSecret *dagger.Secret, projectKey string, waitForQualityGate bool, image string) string  {
	return dag.
			Npm().
			NewSonarConfig(host, tokenSecret, projectKey, waitForQualityGate, image).
			Host(ctx)
}

@function
async def example(host: str, token_secret: dagger.Secret, project_key: str, wait_for_quality_gate: bool, image: str) -> str:
	return await (
		dag.npm()
		.new_sonar_config(host, token_secret, project_key, wait_for_quality_gate, image)
		.host()
	)

@func()
async example(host: string, tokenSecret: Secret, projectKey: string, waitForQualityGate: boolean, image: string): Promise<string> {
	return dag
		.npm()
		.newSonarConfig(host, tokenSecret, projectKey, waitForQualityGate, image)
		.host()
}

tokenSecret() 🔗

Return Type

Secret !

Example

dagger -m github.com/BasisTI/daggerverse/npm@98994f07b1dd76282dd1f3fdc59cfef6c646bf5d call \
 new-sonar-config --host string --token-secret env:MYSECRET --project-key string --wait-for-quality-gate boolean --image string \
 token-secret

func (m *MyModule) Example(host string, tokenSecret *dagger.Secret, projectKey string, waitForQualityGate bool, image string) *dagger.Secret  {
	return dag.
			Npm().
			NewSonarConfig(host, tokenSecret, projectKey, waitForQualityGate, image).
			TokenSecret()
}

@function
def example(host: str, token_secret: dagger.Secret, project_key: str, wait_for_quality_gate: bool, image: str) -> dagger.Secret:
	return (
		dag.npm()
		.new_sonar_config(host, token_secret, project_key, wait_for_quality_gate, image)
		.token_secret()
	)

@func()
example(host: string, tokenSecret: Secret, projectKey: string, waitForQualityGate: boolean, image: string): Secret {
	return dag
		.npm()
		.newSonarConfig(host, tokenSecret, projectKey, waitForQualityGate, image)
		.tokenSecret()
}

projectKey() 🔗

Return Type

String !

Example

dagger -m github.com/BasisTI/daggerverse/npm@98994f07b1dd76282dd1f3fdc59cfef6c646bf5d call \
 new-sonar-config --host string --token-secret env:MYSECRET --project-key string --wait-for-quality-gate boolean --image string \
 project-key

func (m *MyModule) Example(ctx context.Context, host string, tokenSecret *dagger.Secret, projectKey string, waitForQualityGate bool, image string) string  {
	return dag.
			Npm().
			NewSonarConfig(host, tokenSecret, projectKey, waitForQualityGate, image).
			ProjectKey(ctx)
}

@function
async def example(host: str, token_secret: dagger.Secret, project_key: str, wait_for_quality_gate: bool, image: str) -> str:
	return await (
		dag.npm()
		.new_sonar_config(host, token_secret, project_key, wait_for_quality_gate, image)
		.project_key()
	)

@func()
async example(host: string, tokenSecret: Secret, projectKey: string, waitForQualityGate: boolean, image: string): Promise<string> {
	return dag
		.npm()
		.newSonarConfig(host, tokenSecret, projectKey, waitForQualityGate, image)
		.projectKey()
}

waitForQualityGate() 🔗

Return Type

Boolean !

Example

dagger -m github.com/BasisTI/daggerverse/npm@98994f07b1dd76282dd1f3fdc59cfef6c646bf5d call \
 new-sonar-config --host string --token-secret env:MYSECRET --project-key string --wait-for-quality-gate boolean --image string \
 wait-for-quality-gate

func (m *MyModule) Example(ctx context.Context, host string, tokenSecret *dagger.Secret, projectKey string, waitForQualityGate bool, image string) bool  {
	return dag.
			Npm().
			NewSonarConfig(host, tokenSecret, projectKey, waitForQualityGate, image).
			WaitForQualityGate(ctx)
}

@function
async def example(host: str, token_secret: dagger.Secret, project_key: str, wait_for_quality_gate: bool, image: str) -> bool:
	return await (
		dag.npm()
		.new_sonar_config(host, token_secret, project_key, wait_for_quality_gate, image)
		.wait_for_quality_gate()
	)

@func()
async example(host: string, tokenSecret: Secret, projectKey: string, waitForQualityGate: boolean, image: string): Promise<boolean> {
	return dag
		.npm()
		.newSonarConfig(host, tokenSecret, projectKey, waitForQualityGate, image)
		.waitForQualityGate()
}

extraOptions() 🔗

Return Type

[String ! ] !

Example

dagger -m github.com/BasisTI/daggerverse/npm@98994f07b1dd76282dd1f3fdc59cfef6c646bf5d call \
 new-sonar-config --host string --token-secret env:MYSECRET --project-key string --wait-for-quality-gate boolean --image string \
 extra-options

func (m *MyModule) Example(ctx context.Context, host string, tokenSecret *dagger.Secret, projectKey string, waitForQualityGate bool, image string) []string  {
	return dag.
			Npm().
			NewSonarConfig(host, tokenSecret, projectKey, waitForQualityGate, image).
			ExtraOptions(ctx)
}

@function
async def example(host: str, token_secret: dagger.Secret, project_key: str, wait_for_quality_gate: bool, image: str) -> List[str]:
	return await (
		dag.npm()
		.new_sonar_config(host, token_secret, project_key, wait_for_quality_gate, image)
		.extra_options()
	)

@func()
async example(host: string, tokenSecret: Secret, projectKey: string, waitForQualityGate: boolean, image: string): Promise<string[]> {
	return dag
		.npm()
		.newSonarConfig(host, tokenSecret, projectKey, waitForQualityGate, image)
		.extraOptions()
}

image() 🔗

Return Type

String !

Example

dagger -m github.com/BasisTI/daggerverse/npm@98994f07b1dd76282dd1f3fdc59cfef6c646bf5d call \
 new-sonar-config --host string --token-secret env:MYSECRET --project-key string --wait-for-quality-gate boolean --image string \
 image

func (m *MyModule) Example(ctx context.Context, host string, tokenSecret *dagger.Secret, projectKey string, waitForQualityGate bool, image string) string  {
	return dag.
			Npm().
			NewSonarConfig(host, tokenSecret, projectKey, waitForQualityGate, image).
			Image(ctx)
}

@function
async def example(host: str, token_secret: dagger.Secret, project_key: str, wait_for_quality_gate: bool, image: str) -> str:
	return await (
		dag.npm()
		.new_sonar_config(host, token_secret, project_key, wait_for_quality_gate, image)
		.image()
	)

@func()
async example(host: string, tokenSecret: Secret, projectKey: string, waitForQualityGate: boolean, image: string): Promise<string> {
	return dag
		.npm()
		.newSonarConfig(host, tokenSecret, projectKey, waitForQualityGate, image)
		.image()
}