summit-sdk
v1.0.28
Published
A modern TypeScript SDK
Readme
Summit SDK
A modern TypeScript SDK for interacting with the Summit API.
Installation
npm install summit-sdkUsage
import { SummitSDK } from 'summit-sdk';
// Initialize the SDK
const sdk = new SummitSDK({
apiKey: 'your-api-key',
baseUrl: 'https://custom-api.summit.com/v1', // Optional
});
// Use the SDK
await sdk.initialize();Development
Setup
- Clone the repository
- Install dependencies:
npm install
Available Scripts
npm run build- Build the SDKnpm test- Run testsnpm run test:watch- Run tests in watch modenpm run lint- Lint the codenpm run lint:fix- Fix linting issuesnpm run format- Format the codenpm run docs- Generate documentationnpm run clean- Clean build artifacts
Testing
Tests are written using Jest. Run them with:
npm testDocumentation
Documentation is generated using TypeDoc. Generate it with:
npm run docsLicense
MIT
