skyweaver
TypeScript icon, indicating that this package has built-in type declarations

0.3.2 • Public • Published

skyweaver.js

Skyweaver API & Developer SDK for Web, React Native and Nodejs.

The skyweaver.js SDK provides type-safe access to the Skyweaver API. The best reference is to read the Client API interface to learn the available methods and check out the examples.

Install

npm install skyweaver

or

yarn add skyweaver

Running the examples

Please see our web and node examples using skyweaver.js

To run the examples:

  1. Clone this repo -- git clone git@github.com:horizon-games/skyweaver.js.git
  2. cd skyweaver.js/examples/web-app
  3. yarn install
  4. update the example source to set apiAccessToken with your api key
  5. yarn dev
  6. have fun :D

Request a Skyweaver API Key

https://request-api-key.skyweaver.net

Note to developers

The Skyweaver API is built on webrpc, which code-generates the API client source into a single file: /src/skyweaver-api.gen.ts.

The source is very readable and a great reference for the capabilities of the API. Simply jump to export interface SkyWeaverAPI in the source to view the interface type which defines all RPC methods/endpoints of the Skyweaver API.

Support

If you have any questions, please visit our discord at https://discord.gg/skyweaver and ask in our #talk-to-the-devs channel.

Wishing you all the best and welcome any feedback :)

-Horizon team

Readme

Keywords

none

Package Sidebar

Install

npm i skyweaver

Weekly Downloads

25

Version

0.3.2

License

MIT

Unpacked Size

132 kB

Total Files

7

Last publish

Collaborators

  • pkieltyka