History

Komal 3ef2648f45 Use test-org from env var (#7016 )		2021-05-11 08:41:21 -07:00
..
asset	Mark internal APIs `@internal` to filter from API docs (#3809 )	2020-01-26 09:06:35 -08:00
automation	Add user agent to the CLI, Go and Nodejs Automation API SDKs (#6935 )	2021-04-30 07:26:23 -07:00
cmd	Fix noisy nodejs runtime errors (#6995 )	2021-05-10 15:04:03 -07:00
dist
dynamic	Enable nodejs dynamic provider caching by default on program side (#6704 )	2021-04-14 19:32:18 +01:00
iterable
log	[sdk/nodejs] Improve handling of log related errors (#6714 )	2021-04-06 19:34:15 -07:00
npm	[breaking] Changing the version of go.mod in sdk / pkg to be v3	2021-04-14 19:32:18 +01:00
proto	[sdk/proto] Add providers field to RegisterResourceRequest (#6761 )	2021-04-13 15:19:24 -06:00
provider	[sdk/nodejs] Keep prompt values prompt in construct (#6522 )	2021-04-09 14:36:22 -07:00
queryable
runtime	Fix noisy nodejs runtime errors (#6995 )	2021-05-10 15:04:03 -07:00
tests	Use test-org from env var (#7016 )	2021-05-11 08:41:21 -07:00
tests_with_mocks	Refactor Mock newResource and call to accept property bag rather than individual args (#6672 )	2021-04-14 19:32:18 +01:00
.gitignore
config.ts	Mark internal APIs `@internal` to filter from API docs (#3809 )	2020-01-26 09:06:35 -08:00
errors.ts	support inline programs for nodejs automation api	2020-10-08 12:19:01 -07:00
index.ts	Removing x namespace from go/python/nodejs automation packages (#6518 )	2021-04-14 19:32:18 +01:00
invoke.ts	Breaking changes due to Feature 2.0 work	2020-04-14 09:30:25 +01:00
Makefile	[breaking] Changing the version of go.mod in sdk / pkg to be v3	2021-04-14 19:32:18 +01:00
metadata.ts
output.ts	Run SDK lint jobs (#6674 )	2021-04-01 11:23:47 -07:00
package.json	[automation/nodejs] - Expose structured logging (#6454 )	2021-03-11 11:45:28 -08:00
README.md
resource.ts	[sdk/nodejs] Handle providers for RegisterResourceRequest (#6795 )	2021-04-19 16:41:53 -06:00
stackReference.ts	Breaking changes due to Feature 2.0 work	2020-04-14 09:30:25 +01:00
tsconfig.json	Removing x namespace from go/python/nodejs automation packages (#6518 )	2021-04-14 19:32:18 +01:00
tslint.json
utils.ts	Enable resource reference feature by default (#5905 )	2020-12-10 11:21:05 -07:00
version.ts

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. Please visit pulumi.com for installation instructions.

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 the Active LTS and Current releases, as defined by this table. 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

The first time you build, run make ensure to install and prepare native plugins for V8:

$ make ensure

This is only necessary if you intend to produce a build that is capable of running older versions of the SDK contained in this directory. If you do intend to do this, you must have node 6.10.2 installed.

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 /opt/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.