pulumi/sdk/nodejs
Julien c6e5640805
Don't hang indefinitely on failed inputs (#17899)
Ensure we always mark the register resource RPC call as completed, even
when an error occurs.

Fixes https://github.com/pulumi/pulumi/issues/17613
2024-12-03 10:18:25 +00:00
..
asset Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
automation Fixed a bug where token information was not present in types (#17735) 2024-12-01 07:39:51 +00:00
cmd Add GetRequiredPackages to the language host (#17894) 2024-12-02 20:24:23 +00:00
dist Fix typo in PP script 2019-08-06 17:35:52 -07:00
dynamic Allow accessing configuration in Node.js dynamic providers (#17697) 2024-11-07 14:34:11 +00:00
iterable Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
log Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
npm Fix pnpm pack for pnpm@9.13 (#17766) 2024-11-13 15:56:22 +00:00
proto Add GetRequiredPackages to the language host (#17894) 2024-12-02 20:24:23 +00:00
provider implement parameterize in the NodeJS provider interface (#17738) 2024-11-13 09:20:53 +00:00
queryable Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
runtime Don't hang indefinitely on failed inputs (#17899) 2024-12-03 10:18:25 +00:00
tests Don't hang indefinitely on failed inputs (#17899) 2024-12-03 10:18:25 +00:00
tests_with_mocks Fix NodeJS SDK mocking of custom resource reads (#16542) 2024-07-01 16:05:30 +00:00
types Replace deprecated read-package-tree with @npmcli/arborist (#15503) 2024-02-26 18:40:28 +00:00
vendor Vendor TypeScript and ts-node (#15622) 2024-04-10 15:26:37 +00:00
.eslintrc.js Vendor TypeScript and ts-node (#15622) 2024-04-10 15:26:37 +00:00
.gitignore Vendor TypeScript and ts-node (#15622) 2024-04-10 15:26:37 +00:00
.npmignore Exclude tests from the nodejs npm package (#17488) 2024-10-07 08:31:28 +00:00
Makefile add lint_fix Makefile targets (#17767) 2024-11-15 09:58:20 +00:00
README.md fix some links 2023-05-19 19:39:26 -07:00
biome.json Replace Rome with Biome in the NodeJS SDK (#16456) 2024-06-24 11:14:56 +00:00
config.ts Replace Rome with Biome in the NodeJS SDK (#16456) 2024-06-24 11:14:56 +00:00
errors.ts allow better grpc error messages from NodeJS component providers (#17325) 2024-10-03 10:06:37 +00:00
index.ts Removing x namespace from go/python/nodejs automation packages (#6518) 2021-04-14 19:32:18 +01:00
invoke.ts [Node.js] Allow specifiying dependencies for output invokes (#17632) 2024-11-20 16:03:11 +00:00
metadata.ts Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
output.ts [sdk/nodejs] Throw from output() on circular structures (#17852) 2024-11-27 18:40:29 +00:00
package.json Freeze v3.142.0 (#17873) 2024-11-26 15:46:25 +00:00
resource.ts Try and avoid serializing `runtime/resource.js` (#17247) 2024-09-12 16:27:53 +00:00
stackReference.ts Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
tsconfig.json [Node.js] Allow specifiying dependencies for output invokes (#17632) 2024-11-20 16:03:11 +00:00
tsutils.ts Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
typescript-shim.ts Vendor TypeScript and ts-node (#15622) 2024-04-10 15:26:37 +00:00
utils.ts Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
version.ts Freeze v3.142.0 (#17873) 2024-11-26 15:46:25 +00:00
yarn.lock Bump cross-spawn from 7.0.3 to 7.0.6 in /sdk/nodejs in the npm_and_yarn group across 1 directory (#17805) 2024-12-03 01:13:17 +00:00

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.