Skip to content

A JavaScript library to interact with AKSO's API

License

Notifications You must be signed in to change notification settings

AksoEo/client-js

Repository files navigation

AKSO Client

This is a javascript library to interact with the AKSO API.

Installation

This package is available on npm:

npm install @tejo/akso-client

It requires ESM.

Usage Notes

  • Use UserClient to get started with user-based authentication
  • Use AppClient for app-based authentication (i.e. with API keys and such)
  • UEACode provides various utilities for dealing with the new and old code format
  • generateTotp generates TOTP secrets and is useful for applications implementing account creation
  • This library also exports a msgpackCodec as it differs slightly from the defaults
  • util includes miscellaneous functions (e.g. for dealing with search strings)

For more details see the documentation or the JSDoc in this library.

Development Notes

Build with npm run build, or watch with npm run watch.

Building will create a dist with two files for nodejs ESM and browser ESM for use with module bundlers.

About

A JavaScript library to interact with AKSO's API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published