skyweaver
v0.3.2
Published
Skyweaver API & Developer SDK for Web, React Native and Nodejs
Downloads
2
Readme
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:
- Clone this repo --
git clone [email protected]:horizon-games/skyweaver.js.git
cd skyweaver.js/examples/web-app
yarn install
- update the example source to set
apiAccessToken
with your api key yarn dev
- 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