pulumi/sdk/nodejs
Abhinav Gupta 69762acedf
grpc: WithInsecure is deprecated
grpc.WithInsecure is deprecated [1].
Instead, we're expected to use:

    grpc.WithTransportCredentials(insecure.NewCredentials())

This updates all instances across pkg/, sdk/ and tests/.

  [1]: https://pkg.go.dev/google.golang.org/grpc#WithInsecure

In service to #11808
2023-01-11 12:15:40 -08:00
..
asset Use ESlint instead of TSlint (#7719) 2021-08-10 11:31:59 -07:00
automation [auto] Add SkipInstallDependencies option for remote workspaces 2022-12-19 10:27:01 -05:00
cmd grpc: WithInsecure is deprecated 2023-01-11 12:15:40 -08:00
dist Fix typo in PP script 2019-08-06 17:35:52 -07:00
dynamic Avoid importing typescript unless necessary (#10185) 2022-07-20 17:38:55 -04:00
iterable Use ESlint instead of TSlint (#7719) 2021-08-10 11:31:59 -07:00
log Use ESlint instead of TSlint (#7719) 2021-08-10 11:31:59 -07:00
npm all: Drop ioutil 2023-01-06 16:35:14 -08:00
proto Phase 3 of the convert mapper 2022-12-01 23:43:43 +00:00
provider [sdk/nodejs] Mark internal APIs `@internal` to filter from SDK docs 2022-09-20 11:54:06 -07:00
queryable Use ESlint instead of TSlint (#7719) 2021-08-10 11:31:59 -07:00
runtime feat(sdk/nodejs): delegates alias computation to the engine 2022-12-15 17:23:31 -05:00
tests Add jsonParse to nodejs sdk 2022-12-28 09:30:24 +00:00
tests_with_mocks [sdk/{nodejs,python}] Fix errors when testing remote components with mocks (#8053) 2021-09-24 06:08:13 -07:00
.eslintrc.js [sdk/nodejs] Avoid eslint error in VS Code 2022-10-19 16:39:22 -07:00
.gitignore ci: Pin yarn lockfile for security & dependency scanning 2022-09-21 15:35:43 -07:00
Makefile [auto/nodejs] Test remote operations 2022-11-09 05:26:07 -08:00
README.md adjust link text in node sdk readme (#8816) 2022-01-28 16:45:55 -08:00
config.ts fix: Allows for parallel pulumi programs to run in the node runtime 2022-10-13 07:15:25 -04:00
errors.ts Use ESlint instead of TSlint (#7719) 2021-08-10 11:31:59 -07: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 jsonParse to nodejs sdk 2022-12-28 09:30:24 +00:00
package.json Make tracing conditional. Add gRPC instrumentation. 2022-09-15 07:26:52 -04:00
resource.ts feat(sdk/nodejs): delegates alias computation to the engine 2022-12-15 17:23:31 -05:00
stackReference.ts Tidy Nodejs SDK imports (#9658) 2022-05-30 09:31:28 +01:00
tsconfig.json Remove support for old NodeJS versions from function serializer 2022-12-11 21:20:06 +00:00
tsutils.ts [sdk/nodejs] Mark internal APIs `@internal` to filter from SDK docs 2022-09-20 11:54:06 -07:00
utils.ts fix: Allows for parallel pulumi programs to run in the node runtime 2022-10-13 07:15:25 -04:00
version.ts Add license headers 2018-05-22 15:02:47 -07:00
yarn.lock Bump json5 from 1.0.1 to 1.0.2 in /sdk/nodejs 2023-01-04 18:49:40 +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.