pulumi/sdk/nodejs
Fraser Waters 202491bfea
Update grpc-tools and use grpc_js option rather than sed (#14426)
The codegen and test files changed because the old sed script wasn't
correctly fixing up those files, see
https://github.com/pulumi/pulumi/pull/14424 for more on attempting to
fix those scripts. But this gets rid of one of those sed scripts
entirely.
2023-10-27 18:14:20 +00:00
..
asset Apply autoformat 2023-04-28 18:27:10 -04:00
automation stack ls: remove misleading updateInProgress output for file backend (#14309) 2023-10-27 07:33:07 +00:00
cmd Add google-protobuf types (#14422) 2023-10-27 09:55:44 +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 Apply autoformat 2023-04-28 18:27:10 -04:00
npm Merge #13021 #13054 2023-05-30 19:48:20 +00:00
proto Update grpc-tools and use grpc_js option rather than sed (#14426) 2023-10-27 18:14:20 +00:00
provider Add google-protobuf types (#14422) 2023-10-27 09:55:44 +00:00
queryable This commit safely replaces empty interfaces with type aliases. 2023-05-11 23:10:00 -04:00
runtime Add google-protobuf types (#14422) 2023-10-27 09:55:44 +00:00
tests Add google-protobuf types (#14422) 2023-10-27 09:55:44 +00:00
tests_with_mocks Add testing for async TS mocks 2023-06-01 14:13:04 +02:00
.eslintrc.js Add matrix testing (#13705) 2023-09-13 15:17:46 +00:00
.gitignore ci: Pin yarn lockfile for security & dependency scanning 2022-09-21 15:35:43 -07:00
Makefile Fix makefiles 2023-05-26 11:00:45 +01: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 Fix links outputs docs 2023-07-12 14:59:07 -07:00
package.json Add google-protobuf types (#14422) 2023-10-27 09:55:44 +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 Apply autoformat 2023-04-28 18:27:10 -04:00
version.ts Add license headers 2018-05-22 15:02:47 -07:00
yarn.lock Add google-protobuf types (#14422) 2023-10-27 09:55:44 +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.