Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 863 Bytes

README.md

File metadata and controls

41 lines (29 loc) · 863 Bytes

@irclogs/api

Typescript API to access the IrcLog CouchDB database. Mostly typed wrappers over the http api of CouchDB.

Quick start for users

echo "@irclogs:registry=https://npm.pkg.github.com" >> .npmrc
npm install @irclogs/api
# or
yarn add @irclogs/api
# or
pnpm add @irclogs/api

API Playground

See https://irclogs.github.io/api/ to interactively play with the api in your browser.

To use the playground locally run:

pnpm install
pnpm playground:types
pnpm play

and open http://localhost:8000

References

TODO:

  • naming: class name?
  • documentation
  • package publish check auto-versioning schema
  • validation on responses and typing (use zod)