History

CyrusNajmabadi fd6ae9cb7e Suppress further errors at LangHost level if we know the nodejs process reported the errors to the user. (#2596 )		2019-03-27 14:40:29 -07:00
..
asset	Implement rtti checks more consistently (#2498 )	2019-02-28 14:56:35 -08:00
cmd	Suppress further errors at LangHost level if we know the nodejs process reported the errors to the user. (#2596 )	2019-03-27 14:40:29 -07:00
dist	Do not use relative path when launching dynamic provider	2018-12-05 13:45:06 -08: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	Allows the nodejs launcher to recognize that certain types of errors were printed, ensuring we don't cascade less relevant messages. (#2554 )	2019-03-20 11:54:32 -07:00
runtime	Fix issue where we could not serialize an arrow-function with a deconstructed parameter. (#2582 )	2019-03-22 16:48:38 -07:00
tests	Suppress further errors at LangHost level if we know the nodejs process reported the errors to the user. (#2596 )	2019-03-27 14:40:29 -07:00
.gitignore	Continue to add native modules to NODE_PATH	2018-04-13 14:26:32 -07:00
config.ts	Support string literal bounds and return types on Config#get and Config#require (#2570 )	2019-03-20 11:52:44 -07:00
errors.ts	Suppress further errors at LangHost level if we know the nodejs process reported the errors to the user. (#2596 )	2019-03-27 14:40:29 -07:00
index.ts	Break out Resource and Output into their own files (#2420 )	2019-01-31 18:08:17 -08:00
invoke.ts	Pull default options from a resource's parent. (#1748 )	2018-08-10 16:18:21 -07:00
Makefile	Add support for serializing bigints (#2581 )	2019-03-22 15:33:37 -07:00
metadata.ts	Add license headers	2018-05-22 15:02:47 -07:00
output.ts	Revert "Better present interpolated strings during preview. (#2564 )" (#2593 )	2019-03-26 16:36:43 -07:00
package.json	Bump @types/node dependency	2018-11-13 11:20:21 -08:00
README.md	Remove Private Beta warning	2018-06-18 05:00:38 -07:00
resource.ts	Add checks for common mistake of swapping component/custom resource options. (#2555 )	2019-03-13 17:02:17 -07:00
stackReference.ts	Break out Resource and Output into their own files (#2420 )	2019-01-31 18:08:17 -08:00
tsconfig.json	Implement rtti checks more consistently (#2498 )	2019-02-28 14:56:35 -08:00
tslint.json	Fix issue with comments throwing off function/class serialization (#2438 )	2019-02-08 14:58:24 -08:00
utils.ts	Implement rtti checks more consistently (#2498 )	2019-02-28 14:56:35 -08: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. Please visit pulumi.io 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 update from the examples/minimal/ directory. Remember to run tsc first, since pulumi expects JavaScript, not TypeScript.