Skip to content

nitrictech/node-sdk

Repository files navigation

Nitric Logo

@nitric/sdk

The NodeJS SDK supports the use of the cloud-portable Nitric framework with NodeJS 12+.

The SDK is in early stage development and APIs and interfaces are still subject to breaking changes

Prerequisites

  • NodeJS 12+

Getting Started

Using the Nitric CLI

@nitric/sdk is included in all node related SDK projects by default

nitric make:function <node-template> example

Some available node templates are:

  • faas/nodejs12
  • faas/nodets12
  • community/nextjs

Adding to an existing project

NPM

npm install @nitric/sdk

Yarn

yarn add @nitric/sdk

Usage

The nitric node SDK contains modules that cover (Usage examples and detailed API documentation included in the links):

Base gRPC clients are also made available from this package via the grpc module

Local Development

yarn install
yarn build