NpmRegistry

abstract class NpmRegistry : NamedInput

Npm registry configuration

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
@get:Input
abstract val access: Property<NpmAccess>

Registry access

Link copied to clipboard
@get:Input
@get:Optional
abstract val auth: Property<String>

Base64 authentication string when authenticating with the registry. Either authToken, auth or username + password should be provided.

Link copied to clipboard
@get:Input
@get:Optional
abstract val authToken: Property<String>

Auth token to use when authenticating with the registry. Either authToken, auth or username + password should be provided. More info

Link copied to clipboard
@get:Input
@get:Optional
abstract val dry: Property<Boolean>

Specifies if a dry-run should be added to the npm command arguments by default. Dry run does all the normal run des except actual file uploading. Defaults to false.

Link copied to clipboard
@get:InputFile
@get:Optional
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val npmrc: RegularFileProperty

A location of the default .npmrc file. If set, it will be used as a default for all registries that do not have one set explicitly.

Link copied to clipboard
@get:Input
@get:Optional
abstract val otp: Property<String>

Optional OTP to use when authenticating with the registry

Link copied to clipboard
@get:Input
@get:Optional
abstract val password: Property<String>

Password to use when authenticating with the registry. Should always be specified together with a username. Either authToken, auth or username + password should be provided.

Link copied to clipboard
@get:Input
abstract val uri: Property<URI>

NPM registry uri to publish packages to. Should include schema domain and path if required

Link copied to clipboard
@get:Input
@get:Optional
abstract val username: Property<String>

Username to use when authenticating with the registry. Should always be specified together with a password. Either authToken, auth or username + password should be provided.

Functions

Link copied to clipboard
@Input
abstract override fun getName(): String
Link copied to clipboard
fun Property<URI>.set(uri: String)

Convenience DSL to set URI properties via String

fun Property<URI>.set(uri: Provider<String>)

Convenience DSL to set URI properties via Provider<String>