SDK reference

@nimbus/sdk wraps common platform features — auth, key/value storage, and scheduled tasks — so you don’t have to call the REST API directly from inside a function.

JavaScript

npm install @nimbus/sdk

Python

pip install nimbus-sdk

kv

A region-local key/value store, replicated asynchronously to every other region.

JavaScript

import { kv } from '@nimbus/sdk';

await kv.set('user:42', { name: 'Ferris' });
const user = await kv.get('user:42');

Python

from nimbus_sdk import kv

kv.set("user:42", {"name": "Ferris"})
user = kv.get("user:42")

Note

Writes are immediately visible in the region they were made in, but can take up to a few seconds to replicate elsewhere. Don’t rely on kv for cross-region locks.

auth

Verify the session cookie set by Nimbus’s hosted login page.

JavaScript

import { verifySession } from '@nimbus/sdk/auth';

const session = await verifySession(request);

Python

from nimbus_sdk.auth import verify_session

session = verify_session(request)

schedule

Register a function to run on a cron schedule instead of in response to requests.

functions/cleanup.ts

import { schedule } from '@nimbus/sdk';

export default schedule('0 * * * *', async () => {
  // runs once an hour, in one region of Nimbus's choosing
});