History

Fraser Waters 6e3c62b6a5 Generate core schema		2024-02-13 14:17:46 +00:00
..
asset	Apply autoformat	2023-04-28 18:27:10 -04:00
automation	Rename filestate to DIY (#15314 )	2024-01-30 15:53:10 +00:00
cmd	Split CallRequest into ResourceCallRequest (#15404 )	2024-02-08 13:16:23 +00: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	Clean up uses of .Error() (#14965 )	2023-12-20 15:54:06 +00:00
proto	Generate core schema	2024-02-13 14:17:46 +00:00
provider	Move nodejs feature checks to startup (#14856 )	2023-12-19 14:35:23 +00:00
queryable	This commit safely replaces empty interfaces with type aliases.	2023-05-11 23:10:00 -04:00
runtime	Split CallRequest into ResourceCallRequest (#15404 )	2024-02-08 13:16:23 +00:00
tests	Allow disabling version validation when using a custom PulumiCommand isntance (#15242 )	2024-01-26 13:41:10 +00:00
tests_with_mocks	Add testing for async TS mocks	2023-06-01 14:13:04 +02: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
Makefile	increase the timeout for automation API tests (#14844 )	2023-12-13 10:40:27 +00: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	upgrade grpc-js to latest release (#15231 )	2024-01-25 21:22:01 +00:00
resource.ts	[sdk/nodejs] Fix provider for resource methods (#13796 )	2023-08-30 14:49:53 +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	sdk/node/StackReference: Add getOutputDetails	2023-02-03 16:47:27 -08: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
yarn.lock	Bump the npm_and_yarn group across 1 directories with 1 update (#15369 )	2024-02-04 19:10:00 +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.