Skip to content

jexia/jexia-sdk-js

Repository files navigation

Jexia Javascript SDK

CircleCI Chat on Discord

This is the official JavaScript / TypeScript SDK for interacting with Jexia projects.

Install

npm install jexia-sdk-js --save

or

yarn add jexia-sdk-js

Example Use

const jexiaSDK = require("jexia-sdk-js/node"); // use require("jexia-sdk-js/browser") for browser
const dataModule = jexiaSDK.dataOperations();

const credentials = {
  projectID: "<your-project-id>",
  zone: "<your-project-zone>",
  key: "<your-project-api-key>",
  secret: "<your-project-api-secret>",
};

jexiaSDK.jexiaClient().init(credentials, dataModule);

dataModule
  .dataset("posts")
  .select()
  .subscribe(
    records => console.log("All the records:", records),
    error => console.error("Something wrong happened:", error)
  );

Documentation

Check out documentation on the official Jexia website.

Contributing

You can find all the steps at the Contributing Guide.

License

MIT