pulumi/sdk/nodejs
Maciej Lisiewski bcdd27e092 Updates grpc package to 1.24.2 for js sdk (#3512)
Fixes building grpc package with gcc8 and newer
Fixes building grpc package for node 13.x
Matches minor grpc release (1.24.x) to version used by dotnet sdk
2019-11-19 11:56:26 -08:00
..
asset Properly mark members as @internal (#2670) 2019-04-23 19:24:06 -07:00
cmd Add StreamInvoke to dynamic provider 2019-11-12 13:51:19 -08:00
dist Fix typo in PP script 2019-08-06 17:35:52 -07:00
dynamic Break out Resource and Output into their own files (#2420) 2019-01-31 18:08:17 -08:00
iterable Break out Resource and Output into their own files (#2420) 2019-01-31 18:08:17 -08:00
log Have child resources update their parent urn to include themselves in its dependencies. (#2299) 2019-02-21 20:18:29 -08:00
proto Propagate inputs to outputs during preview. (#3327) 2019-11-11 12:09:34 -08:00
queryable Expose queryable.Resolved<T> publicly 2019-09-30 16:49:11 -07:00
runtime StreamInvoke should return AsyncIterable that completes 2019-11-12 13:51:19 -08:00
tests StreamInvoke should return AsyncIterable that completes 2019-11-12 13:51:19 -08:00
.gitignore Add a SxS test for @pulumi/pulumi to help catch when we make breaking changes to core types. (#2610) 2019-03-29 12:27:42 -07:00
config.ts Add some convience methods to pulumi.Config for getting secrets 2019-05-10 17:07:52 -07:00
errors.ts Properly mark members as @internal (#2670) 2019-04-23 19:24:06 -07:00
index.ts Add a helper function to easily convert async functions to sync functions (#2943) 2019-07-16 12:12:21 -07:00
invoke.ts Add an option to allow callers to specify they would like make invoke calls asynchronously. (#2947) 2019-07-18 17:19:41 -07:00
Makefile Fixing Istanbul usage 2019-11-05 11:17:07 -08:00
metadata.ts Enable unit testing for Pulumi programs (#2638) 2019-04-16 22:20:01 -07:00
output.ts Propagate inputs to outputs during preview. (#3327) 2019-11-11 12:09:34 -08:00
package.json Updates grpc package to 1.24.2 for js sdk (#3512) 2019-11-19 11:56:26 -08:00
README.md Update references to pulumi.io (#2979) 2019-07-25 09:58:12 -07:00
resource.ts Remove unnecessary casts (#3367) 2019-10-17 17:12:45 -07:00
stackReference.ts Enable full strict mode. (#3218) 2019-09-11 16:21:35 -07:00
tsconfig.json StreamInvoke should return AsyncIterable that completes 2019-11-12 13:51:19 -08:00
tslint.json Fix issue with comments throwing off function/class serialization (#2438) 2019-02-08 14:58:24 -08:00
utils.ts New approach to move us to using deasync as little as possible (and with as little impact to users as possible). (#3325) 2019-10-14 22:08:06 -07:00
version.ts Add license headers 2018-05-22 15:02:47 -07:00

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.