TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.projectFeatures/NpmRegistryConnection

NpmRegistryConnection

open class NpmRegistryConnection : ProjectFeature

fun ProjectFeatures.npmRegistry(init: NpmRegistryConnection.() -> Unit): NpmRegistryConnection

Adds an npm registries connection project feature.

Example. Adds an npm registry connection project feature. Please note that corresponding build feature should be provided in build configuration to use this connection. This connection will be used only inside nodeJS build steps.

project {
    // ...
    buildType(Build)

    features {
        npmRegistry {
            id = "PROJECT_EXT_NPM_REG"
            name = "NPM Registry"
            scope = "scope"
            token = "credentialsJSON:xxx"
        }
    }
}

object Build : BuildType({
    name = "Build"
    // ...
    features {
        npmRegistry {
            connectionId = "PROJECT_EXT_NPM_REG"
        }
    }

    steps {
        nodeJS {
            shellScript = """
                npm ci
                npm run test
            """.trimIndent()
        }
    }
})

Constructors

NpmRegistryConnection

constructor(init: NpmRegistryConnection.() -> Unit)

constructor()

Properties

var id: String?

Project feature id, if not specified will be generated

name

var name: String?

Npm registry connection display name

params

val params: List<Parameter>

scope

var scope: String?

Scope for registry. Leave empty to override default registry.

token

var token: String?

Token with access to repository

type

var type: String

Project feature type

url

var url: String?

Npm registry URL, Format: 'http(s)://hostname:port'

Functions

booleanParameter

fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): DelegateProvider<Boolean?>

clear

fun clear()

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): DelegateProvider<T>

copyParamsTo

fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

create

open fun create(): ProjectFeature

Creates an instance of this project feature via reflection using a no argument constructor, used during copying. Throws an error if this class doesn't have a default constructor. Subclasses can override it to create an instance without using a default constructor.

doubleParameter