cosmos-explorer/public/datafeeds/udf/README.md

UDF Compatible Datafeed

This folder contains UDF datafeed adapter. It implements JS API and makes HTTP requests using UDF protocol.

You can use this datafeed adapter to plug your data if you implement UDF on your server. You can also scrutinize how it works before writing your own adapter.

This datafeed is implemented in TypeScript.

Folders content

• ./src folder contains the source code in TypeScript.

• ./lib folder contains transpiled in es5 code. So, if you do not know how to use TypeScript - you can modify these files to change the result bundle later.

• ./dist folder contains bundled JavaScript files which can be inlined into a page and used in the Widget Constructor.

Build & bundle

Before building or bundling your code you need to run npm install to install dependencies.

package.json contains some handy scripts to build or generate the bundle:

• npm run compile to compile TypeScript source code into JavaScript files (output will be in ./lib folder)
• npm run bundle-js to bundle multiple JavaScript files into one bundle (it also bundle polyfills)
• npm run build to compile and bundle (it is a combination of all above commands)

NOTE: if you want to minify the bundle code, you need to set ENV environment variable to a value different from development.

For example:

export ENV=prod
npm run bundle-js # or npm run build

or

ENV=prod npm run bundle-js

or

ENV=prod npm run build