@stacksflowr/my-sdk
v2.0.3
Published
A REST API wrapper SDK
Readme
Stacksflowr SDK
A lightweight, TypeScript-first Node.js SDK for wrapping REST APIs — built for simplicity and extensibility.
Installation
npm install @stacksflowr/my-sdkQuick Start
import MySDK from "@stacksflowr/my-sdk";
const sdk = new MySDK({
baseURL: "https://api.example.com",
apiKey: "your-api-key",
});Usage
Users
// List users
const users = await sdk.users.list({ page: 1, limit: 10 });
// Get a single user
const user = await sdk.users.get("user-123");
// Create a user
const newUser = await sdk.users.create({
name: "Ada Lovelace",
email: "[email protected]",
});
// Update a user
const updated = await sdk.users.update("user-123", { name: "Ada L." });
Delete a user
await sdk.users.delete("user-123");Configuration
| Option | Type | Required | Description |
|-----------|----------|----------|------------------------------------|
| baseURL | string | ✅ | Base URL of your REST API |
| apiKey | string | ✅ | API key for Authorization header |
| timeout | number | ❌ | Request timeout in ms (default: 10000) |