History

Thomas Gummerer e47e2d271e I think all Go works now		2024-04-05 18:02:17 +02:00
..
asset	Apply autoformat	2023-04-28 18:27:10 -04:00
automation	improve error message when gRPC fails (#15656 )	2024-03-13 09:07:54 +00:00
cmd	I think all Go works now	2024-04-05 18:02:17 +02:00
dist	Fix typo in PP script	2019-08-06 17:35:52 -07:00
dynamic	Allow dynamic providers to capture secrets	2023-06-29 15:28:31 -07:00
iterable	Apply autoformat	2023-04-28 18:27:10 -04:00
log	Move nodejs feature checks to startup (#14856 )	2023-12-19 14:35:23 +00:00
npm	building //sdk works	2024-04-04 09:33:48 +02:00
proto	Clean up unused import warnings (#15581 )	2024-03-04 13:01:25 +00:00
provider	Cleanup so uses of `any` in the nodejs sdk (#15558 )	2024-03-02 00:00:57 +00:00
queryable	This commit safely replaces empty interfaces with type aliases.	2023-05-11 23:10:00 -04:00
runtime	Replace glob with fdir to avoid an indirect dependency on inflight. (#15617 )	2024-03-12 10:44:03 +00:00
tests	I think all Go works now	2024-04-05 18:02:17 +02:00
tests_with_mocks	Add testing for async TS mocks	2023-06-01 14:13:04 +02:00
types	Replace deprecated read-package-tree with @npmcli/arborist (#15503 )	2024-02-26 18:40:28 +00:00
.eslintrc.js	Update node sdk to use typescript definitions for grpc and protobufs. (#14415 )	2023-12-04 15:22:44 +00:00
.gitignore	ci: Pin yarn lockfile for security & dependency scanning	2022-09-21 15:35:43 -07:00
BUILD.bazel	I think all Go works now	2024-04-05 18:02:17 +02:00
Makefile	more hackety hack	2024-04-05 17:33:44 +02:00
README.md	fix some links	2023-05-19 19:39:26 -07:00
config.ts	Add --secret to config set hints when needed	2023-06-22 17:25:30 +01:00
errors.ts	Remove Useless Constructors.	2023-05-15 19:48:47 -04:00
index.ts	Removing x namespace from go/python/nodejs automation packages (#6518 )	2021-04-14 19:32:18 +01:00
invoke.ts	[sdk/nodejs] Add pluginServerURL (#8698 )	2022-01-10 15:54:41 -08:00
metadata.ts	Make getOrganization total, default to 'organization'	2022-09-22 11:06:51 -07:00
output.ts	Add option to throw on output toString and toJSON calls (#14811 )	2023-12-20 11:43:07 +00:00
package.json	some more fixes	2024-04-05 12:22:59 +02:00
resource.ts	NodeJS transforms (#15532 )	2024-03-07 08:52:34 +00:00
rome.json	Add matrix testing (#13705 )	2023-09-13 15:17:46 +00:00
stackReference.ts	Apply autoformat	2023-04-28 18:27:10 -04:00
tsconfig.json	Fix codepaths computation when working dir is nested relative to package.json (#15601 )	2024-03-08 16:16:47 +00:00
tsutils.ts	[sdk/nodejs] Mark internal APIs `@internal` to filter from SDK docs	2022-09-20 11:54:06 -07:00
utils.ts	Add option to throw on output toString and toJSON calls (#14811 )	2023-12-20 11:43:07 +00:00
version.ts	Add license headers	2018-05-22 15:02:47 -07: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.