README
ORXe-Core-SDK
ORXe-Core-SDK provides helper functions/methods to get get or post data from APIs and convey at the App level and microApp level. There are two use case for these SDKs, one is dev(development) and second one is prod(production). There are many SDKs which we are going to use in ORXE as Session, App Settings, Configuration, Culture and etc. Few of them will have initialisation and other can bypass initialisatoina and provide their features directly.
Get Started
npm install --save orxe-sdk
Features
As of now, this library provides below capabilities:
ORXe App (In Progress)
This is the core SDK, which will provide all available SDKs for application.
Usage
You need to import package in your file
import { OrxeApp } from "orxe-sdk";
API/Methods
API/Method Name/Properties | Description | Usage | Output/Response |
---|---|---|---|
accessToken |
Here you can get the session token if OrxeSdk is initialized already else it would be undefined. (This approach can be changed later based on implementation) | OrxeApp.accessToken |
s0m3a1f2n0m3r1c4t7i7d |
initialize |
This method is to initialize core sdk, it will accept a user token(This can change later). If token is empty, this will throw error. | OrxeApp.initialize("TOKEN") |
{ sessionid: s0m3a1f2n0m3r1c4t7i7d } |
Request
TBD