@barchart/events-api-common
v5.2.0
Published
Common classes used by the Barchart Event Tracking System
Downloads
108
Maintainers
Keywords
Readme
@barchart/events-api-common
A public library of JavaScript code used Barchart Event Tracking Service — a simple tool for collecting and reporting usage statistics.
Overview
Simply put, this project contains code that runs on both the servers (i.e. Serverless applications) and clients (e.g. browser, mobile, etc).
/lib/data/serialization
Data is passed between client and server in JSON format. However, the code works with more complex types. For example, Decimal
instances are used in place of native JavaScript floats and Day
instances are used instead of native JavaScript Dates.
So, before data is exchanged, it must be converted to pure JSON. Conversely, when data is received, as pure JSON, it's translated into more complex types before use. This is facilitated by the Schema
definitions which build custom "reviver" functions for JSON parsing.
Notable Consumers
- @barchart/events-private - Serverless applications (i.e. the backend).
- @barchart/events-client-js - JavaScript SDK for communicating with the backend.
Package Managers
This library has been published as a public module to NPM as @barchart/events-api-common.