e70114a105
Tentative changelog ### Features - [cli/package] Add the `pulumi package add` command for installing packages and SDKs [#16923](https://github.com/pulumi/pulumi/pull/16923) - [sdkgen/dotnet] Support parameterized .NET provider SDKs [#16912](https://github.com/pulumi/pulumi/pull/16912) - [sdk/nodejs] Add parameterization support for read in nodejs [#16913](https://github.com/pulumi/pulumi/pull/16913) - [sdk/python] Add parameterization support for call & read in python [#16915](https://github.com/pulumi/pulumi/pull/16915) - [sdkgen/go] Go SDKs will default the import path based on the publisher and repository schema fields [#16899](https://github.com/pulumi/pulumi/pull/16899) - [sdkgen/nodejs] Add parameterized provider support for Nodejs SDK [#16901](https://github.com/pulumi/pulumi/pull/16901) ### Bug Fixes - [sdk/go] NewPropertyMapFromMap will flow PropertyValues through it, rather than dropping them [#16894](https://github.com/pulumi/pulumi/pull/16894) - [sdk/nodejs] Pass through pluginDownloadURL in invokes ### Miscellaneous - [pkg] Upgrade pulumi-java to v0.13.0 [#16882](https://github.com/pulumi/pulumi/pull/16882) |
||
---|---|---|
.. | ||
asset | ||
automation | ||
cmd | ||
dist | ||
dynamic | ||
iterable | ||
log | ||
npm | ||
proto | ||
provider | ||
queryable | ||
runtime | ||
tests | ||
tests_with_mocks | ||
types | ||
vendor | ||
.eslintrc.js | ||
.gitignore | ||
Makefile | ||
README.md | ||
biome.json | ||
config.ts | ||
errors.ts | ||
index.ts | ||
invoke.ts | ||
metadata.ts | ||
output.ts | ||
package.json | ||
resource.ts | ||
stackReference.ts | ||
tsconfig.json | ||
tsutils.ts | ||
typescript-shim.ts | ||
utils.ts | ||
version.ts | ||
yarn.lock |
README.md
Pulumi Node.js SDK
The Pulumi Node.js SDK lets you write cloud programs in JavaScript.
Installation
Using npm:
$ npm install --save @pulumi/pulumi
Using yarn:
$ yarn add @pulumi/pulumi
This SDK is meant for use with the Pulumi CLI. Visit Pulumi's Download & Install to install the CLI.
Building and Testing
For anybody who wants to build from source, here is how you do it.
Prerequisites
This SDK uses Node.js and we support any of the Current, Active and Maintenance LTS versions. We support both NPM and Yarn for package management.
At the moment, we only support building on macOS and Linux, where standard GNU tools like make
are available.
Make Targets
To build the SDK, simply run make
from the root directory (where this README
lives, at sdk/nodejs/
from the repo's
root). This will build the code, run tests, and install the package and its supporting artifacts.
At the moment, for local development, we install everything into $HOME/.dev-pulumi
. You will want this on your $PATH
.
The tests will verify that everything works, but feel free to try running pulumi preview
and/or pulumi up
from
the examples/minimal/
directory. Remember to run tsc
first, since pulumi
expects JavaScript, not TypeScript.