# rotacloud

> The RotaCloud SDK for the RotaCloud API

Latest version **2.3.29** (published 2026-09-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install rotacloud
pnpm add rotacloud
yarn add rotacloud
bun add rotacloud
```

## Health

**Score 65/100 (B)** — status: active.

Positive: esm support; no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 2.3.29 |
| Published | 2026-09-10 |
| First published | 2022-04-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Node | >=20 |
| Dependencies | 2 |
| Unpacked size | 277.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 1 |
| Maintainers | d44vee |

## Links

- npm: https://www.npmjs.com/package/rotacloud
- Repository: https://github.com/rotacloud/rotacloud-node
- Homepage: https://github.com/rotacloud/rotacloud-node#readme
- Issues: https://github.com/rotacloud/rotacloud-node/issues
- npm.io page: https://npm.io/package/rotacloud

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^1.13.0
- [axios-retry](https://npm.io/package/axios-retry.md) ^4.5.0

## Recent versions

- 2.3.29 (latest) — 2026-09-10
- 2.3.28 — 2026-08-28
- 2.3.27 — 2026-07-31
- 2.3.26 — 2026-05-26
- 2.3.25 — 2026-05-26
- 2.3.24 — 2026-05-07
- 2.3.23 — 2026-03-20
- 2.3.22 — 2026-02-10
- 2.3.19 — 2026-01-27
- 2.3.18 — 2026-01-27
- 2.3.17 — 2026-01-26
- 2.3.16 — 2026-01-26
- 2.3.15 — 2026-01-22
- 2.3.14 — 2026-01-19
- 2.3.13 — 2026-01-19
- … 90 more at https://npm.io/package/rotacloud/versions

## README

# RotaCloud Node SDK

## Getting started

To use this SDK you'll need to `npm install rotacloud`. This will ensure you're ready
to start working with the SDK in your project.

## Contributing

Please ensure you perform the `npm run version:bump` command before commiting and
pushing your changes to the remote branch.

## Local development

When making changes to the SDK and testing them locally with the web app (`rotacloud-app`), follow these steps, provided you have already followed the above ones:

### Initial setup

1.**Build the SDK:**

`npm run build -- --watch`

2.**Link in the web app:**
/ cd rotacloud-app

`npm link rotacloud`

3.**Verify the link is correct:**

`npm ls rotacloud`

Expected output:

```
└── rotacloud@x.x.x -> ./../rotacloud-node
```

The version displayed is the bumped version you are linking the app to.

Once you are sure you have the web app linked to the correct version of the package, you can start up the app and test your changes:

`npm run start`

## Configuration

Configuration is simple, import the `createRotaCloudClient` function from the SDK
and supply your API key:

```typescript
import { createRotaCloudClient } from 'rotacloud';

const client = createRotaCloudClient({
  apiKey: 'YOUR_API_KEY',
});
```

## Auto paging

Our SDK supports auto pagination as a way for developers to quickly consume list based endpoints.
You will find a `list()` method on most services within the SDK which can be consumed using
`for await of`. **Please ensure you are catching errors in your implementation.**

```typescript
const client = createRotaCloudClient({...})

try {
  for await (const user of client.user.list()) {
    console.log(user);
  }
} catch (e) {
  console.log(e);
}
```

## Retry Policies

Our SDK supports both basic and customisable retry polices.
Both can be easily configured in the SDKConfig object at time of instantiation.
Both exponential and static value based back offs are supported.

Only idempotent requests will be retried.

```typescript
import { createRotaCloudClient } from 'rotacloud';

const client = createRotaCloudClient({
  apiKey: 'YOUR_API_KEY',
  retry: 'expo' | 'static',
});
```

If more granular control is required of the internal retry policy values, an object
of retry configuration can be passed through to the `retry` field instead.

```typescript
import { createRotaCloudClient } from 'rotacloud';

const client = createRotaCloudClient({
  apiKey: 'YOUR_API_KEY',
  retry: { delay: 2000, exponential: false, maxRetries: 10 },
});
```

---
_Source: https://npm.io/package/rotacloud · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._