@nitric/sdk
v1.3.2
Published
Nitric NodeJS client sdk
Downloads
668
Keywords
Readme
The NodeJS SDK supports the use of the Nitric framework with NodeJS 12+. For more information, check out the main Nitric repo.
Nitric SDKs provide an infrastructure-as-code style that lets you define resources in code. You can also write the functions that support the logic behind APIs, subscribers and schedules.
You can request the type of access you need to resources such as publishing for topics, without dealing directly with IAM or policy documents.
- Reference Documentation: https://nitric.io/docs/reference/nodejs
- Guides: https://nitric.io/docs/guides/nodejs
Usage
Starting a new project
Install the Nitric CLI, then generate your project:
TypeScript:
nitric new hello-world ts-starter
JavaScript:
nitric new hello-world js-starter
Add to an existing project
First of all, you need to install the library:
npm install @nitric/sdk
Then you're able to import the library and create cloud resources:
import { api, bucket } from '@nitric/sdk';
const publicApi = api('public');
const uploads = bucket('uploads').allow('write');
publicApi.get('/upload', async (ctx) => {
const photo = uploads.file('images/photo.png');
const url = await photo.getUploadUrl({
expiry: 300,
});
return ctx.res.json({ url });
});
Learn more
Learn more by checking out the Nitric documentation.
Get in touch:
Join us on Discord
Ask questions in GitHub discussions
Find us on Twitter
Send us an email