@breign/client
v1.0.46
Published
TypeScript client library for interacting with the Brain API. This package provides a strongly-typed interface generated from OpenAPI specifications.
Downloads
2,105
Readme
@breign/client
TypeScript client library for interacting with the Brain API. This package provides a strongly-typed interface generated from OpenAPI specifications.
Installation
npm install @breign/clientUsage
import { ... } from '@breign/client';
// Configure API key authentication
// Implementation details depend on your use caseDevelopment
Prerequisites
- Node.js (version specified in
.nvmrc) - npm
Setup
- Clone the repository
- Install dependencies:
npm install
Available Scripts
npm run generate- Generates API client from OpenAPI specsnpm run build- Builds the TypeScript projectnpm run clean- Cleans generated and build directoriesnpm run format- Formats code using Prettiernpm run format:check- Checks code formatting
Project Structure
src/resources/openapi/- OpenAPI specificationsdist/- Compiled outputtarget/- Generated source files
TODO
- [ ] Generate API for mobile development (Swift, Kotlin)?
- [ ] Decide if we should use date-time format for dates or strings?
