Skip to content

ember-nexus/web-sdk

Repository files navigation

Ember Nexus: Web SDK

GitHub License NPM Version NPM Downloads GitHub Actions Workflow Status codecov Discord

The Web SDK is a library intended to make working with the Ember Nexus API easier.
It is programmed in a framework-agnostic way.

Quick Links

Features

Using the Web SDK provides multiple advantages over directly connecting to the API itself:

  • Authentication: Authentication and token management are handled for you.
  • Caching: The Web SDK automatically caches elements and reduces unnecessary web requests. Caching can be disabled and bypassed for individual element lookups.
  • Events: All API endpoints can be optionally exposed as browser events. This is especially useful for abstraction and modularization; all official Ember Nexus apps do use these events extensively.
  • Type safety: The SDK is written in TypeScript and uses explicitly defined types all throughout.

Planned Features

See our milestone and issue list on GitHub for planned features.