Javascript SDK Datafile Manager

This package provides datafile manager implementations for Node.js, browsers, and React Native.

Requirements

In general, an ES5-compatible environment is required, as well as Promise (must be polyfilled if absent).

Platform-specific minimum supported versions:

• Node.js: 8
• React Native: 0.61.5

Installation

npm i @eyeofcloud/js-sdk-datafile-manager

For React Native, installation of peer dependency @react-native-async-storage/async-storage is also required:

npm i @react-native-async-storage/async-storage

Usage

const { HttpPollingDatafileManager } = require('@eyeofcloud/js-sdk-datafile-manager')

const manager = new HttpPollingDatafileManager({
  sdkKey: '9LCprAQyd1bs1BBXZ3nVji',
  autoUpdate: true,
  updateInterval: 5000,
})
manager.start()
manager.onReady().then(() => {
  const datafile = manager.get()
  console.log('Manager is ready with datafile: ')
  console.log(datafile)
})
manager.on('update', ({ datafile }) => {
  console.log('New datafile available: ')
  console.log(datafile)
})

Development

• The lint package.json script runs ESLint and Prettier. This applies formatting and lint fixes to all .ts files in the src/ directory.
• The test package.json script runs our Jest-based test suite.
• The tsc package.json script runs the TypeScript compiler to build the final scripts for publishing (into the lib/ directory).