@openfeed/sdk-js
v1.2.2
Published
JavaScript SDK for Barchart OpenFeed
Downloads
270
Keywords
Readme
TS/JS SDK for Barchart Openfeed
TypeScript and JavaScript SDK for Barchart Openfeed is a library that can be used to subscribe to market data messages served by the Barchart Openfeed servers.
Obtaining the Library
Using npm:
npm i --save @openfeed/sdk-js
Using yarn:
yarn add @openfeed/sdk-js
User Guide
The User Guide for this project can be found in the documentation page.
Development
This library uses Conventional Commits for clarity, tracking changes and versioning. It's recommended to install Conventional Commits Extension for VS Code when contributing to the library.
Preparing a new version
For updating the version and automatically collecting changes, run:
yarn build:prepare-release
git push --follow-tags origin master
Updating the Dependencies
To update the protobuf auto-generated files, follow the steps:
- Download the latest protoc executable from here.
- Put the protoc.exe in the root folder of the project
- Run the following command:
yarn generate