@reminix/api
v0.0.2-alpha.0
Published
API client for Reminix TypeScript SDK
Readme
@reminix/api
HTTP client for the Reminix TypeScript SDK. This package provides a fully-featured API client for interacting with the Reminix API.
Installation
npm install @reminix/api
# or
yarn add @reminix/api
# or
pnpm add @reminix/apiUsage
import { ReminixApiClient } from '@reminix/api';
// Initialize the client
const client = new ReminixApiClient({
apiKey: 'your-api-key',
baseUrl: 'https://api.reminix.ai' // optional
});
// Make a GET request
const response = await client.makeRequest('/endpoint');
// Make a POST request
const response = await client.makeRequest('/endpoint', {
method: 'POST',
body: JSON.stringify({
// your data
})
});
// Make a request with custom headers
const response = await client.makeRequest('/endpoint', {
headers: {
'Content-Type': 'application/json',
'X-Custom-Header': 'value'
}
});Features
- Automatic authentication header injection
- TypeScript support
- Configurable base URL
- Works in Node.js environments
- Supports all HTTP methods
- Custom header support
Dependencies
This package depends on:
@reminix/core- Core package with base client and typesnode-fetch- Used for making HTTP requests in Node.js environments
