0.1.0 • Published 2 years ago

@synkar/sara-sdk-ts v0.1.0

Weekly downloads
-
License
ISC
Repository
github
Last release
2 years ago

SARA Typescript SDK

SDK developed by Synkar to use SARA APIs.

Table of Contents

General Information

  • Access SARA APIs in typescript/javascript project.
  • Allow users and clients create its own project that communicate with SARA APIs in a easily way.
  • Better understanding of SARA resources
  • Uxception handling

Features

List the ready features here:

  • Mapping
  • Demo

Setup

SARA Typescript SDK can be installed via npm.

npm install sara-ts-sdk

Or you can install in your package by adding:

npm install https://github.com/Synkar/SARA-TS-SDK

Usage

For usage is simple. You will need to import sara-ts-sdk in you JS/TS project.

import { Sara, Client as SaraClient } from "sara-sdk-ts";

Second you authenticate with you ACCESS_KEY and SECRET_KEY:

await SaraClient.auth(access_key, secret_key);

After authentication process complete you can use modules and resources like:

Sara.Iam.Users.Create({name: "John", email: "john@email.com"})

Project Status

Project is in progress.

Next Improvement

New modules:

  • SRS
  • IAM
  • Missions
  • Telemetry
  • Teleop

To do:

  • Unit testing
  • E2E testing
  • Syntatic exceptions

Contact

Created by @synkar - feel free to contact us!