1.2.8 • Published 7 months ago
sara-sdk-ts v1.2.8
SARA Typescript SDK
SDK developed by Synkar to use SARA APIs.
Table of Contents
- SARA Typescript SDK - Table of Contents - General Information - Features - Setup - Usage - Project Status - Next Improvement - Contact
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:
- IAM
- Mapping
- Missions V2
- Metrics
- Telemetry
- SRS
- Webhook
- Hivemind
- Toolbox
- Demos (Examples)
Setup
SARA Typescript SDK can be installed via npm.
npm install sara-sdk-ts
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-sdk-ts 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:
- Websocket module To do:
- E2E testing
- Syntatic exceptions
Contact
Created by @synkar - feel free to contact us!