@giosg/datasources
v2.0.1
Published
Classes for accessing resources of giosg systems.
Downloads
85
Readme
giosg datasources
This is a collection of resource datasources used to access and modify giosg resources.
How to use
npm install @giosg/datasources
import Datasources from '@giosg/datasources';
const datasources = new Datasources(
authorizationHeader,
reportingServiceOrigin, // Optional
interactionDesignerOrigin, // Optional
realtimeSdk // Optional. Required for streaming. Has to be pre-connected!
);
After adding new datasource you need to npm install
and reload vscode to get rid of errors!
Publishing
Before publishing, remember to consider the effects your changes have for our users. See semantic versioning.
For publishing, you need access to giosg organization in npm. You can request that from one of the organization admins or request them to publish the package.
- Update CHANGELOG.md, run
npm version <patch|minor|major>
andnpm run prepare
, and commit. - Create pull request.
- Request a review from another experienced developer.
- Merge the pull request after approval and passed tests.
- Pull master locally.
- Login to npm with
npm login --scope=giosg
. You will be prompted for credentials. - Publish the package with:
npm publish --access public
.--access public
flag is mandatory because organization packages default torestricted
.
Changelog
Remember to maintain changelog:
See: CHANGELOG.md