Packages > pkg.pkl-lang.org/pkl-pantry/com.github.actions > com.github.actions.actions.setup-node.v4.SetupNode

With1.3.0

Properties
Methods

class With

Known subtypes in package:
Known usages in package:
All versions:

Properties

link

`always-auth`: Boolean?Source

Set always-auth in npmrc.

Default if unspecified: "false"
link

`node-version`: String?Source

Version Spec of the version to use. Examples: 12.x, 10.15.1, >=10.15.0.
link

`node-version-file`: String?Source

File containing the version Spec of the version to use. Examples: package.json, .nvmrc, .node-version, .tool-versions.
link

architecture: String?Source

Target architecture for Node to use. Examples: x86, x64. Will use system architecture by default.
link

`check-latest`: Boolean?Source

Set this option if you want the action to check for the latest available version that satisfies the version spec.

Default if unspecified: false
link

`registry-url`: String?Source

Optional registry to set up for auth. Will set the registry in a project level .npmrc and .yarnrc file, and set up auth to read in from env.NODE_AUTH_TOKEN.
link

scope: String?Source

Optional scope for authenticating against scoped registries. Will fall back to the repository owner when using the GitHub Packages registry (https://npm.pkg.github.com/).
link

token: String?Source

Used to pull node distributions from node-versions. Since there's a default, this is typically not supplied by the user. When running this action on github.com, the default value is sufficient. When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting.

Default if unspecified: "${{ github.server_url == 'https://github.com' && github.token || '' }}"
link

cache: ("npm"|"yarn"|"pnpm")?Source

Used to specify a package manager for caching in the default directory. Supported values: npm, yarn, pnpm.
link

hidden

`cache-dependency-path-list`: Listing<String>?Source

Used to specify the path to a dependency file: package-lock.json, yarn.lock, etc. Supports wildcards or a list of file names for caching multiple dependencies.
link

`cache-dependency-path`: String?Source

Used to specify the path to a dependency file: package-lock.json, yarn.lock, etc. Supports wildcards or a list of file names for caching multiple dependencies.

To set as a Listing, use cache-dependency-path-list.
link

mirror: String?Source

Used to specify an alternative mirror to downlooad Node.js binaries from
link

`mirror-token`: String?Source

The token used as Authorization header when fetching from the mirror

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

Any.toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

Typed.hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

Typed.getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

Typed.getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

Typed.toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

Typed.toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.