@barchart/common-js
Version:
Library of common JavaScript utilities
53 lines (31 loc) • 1.91 kB
Markdown
# @barchart/common-js
[](https://github.com/barchart/common-js)
[](https://www.npmjs.com/package/@barchart/common-js)
A *public* library of JavaScript utilities — suitable for use in both Node.js and browser-based applications.
### Overview
#### Features
* Simple utilities (type checking, assertions, a bit masking, etc.)
* Data structures (decimals, days, enumerations, etc.)
* Simple collections (queues, stacks, trees, etc.)
* Specialized collections (priority queues, evicting lists, evicting maps, etc.)
* Browse the code...
#### Companion Library
A companion library called [@barchart/common-node-js](https://github.com/barchart/barchart-common-node-js) contains utilities for exclusive use in Node.js environments (i.e. not suitable for use in web browsers).
### Development
#### Documentation
The code is documented with [JSDoc](http://usejsdoc.org/). This will be used as the basis for formal documentation (coming soon).
#### Package Managers
This library has been published as a *public* module to NPM as [@barchart/common-js](https://www.npmjs.com/package/@barchart/common-js).
```shell
npm install @barchart/common-js -S
```
#### Build
Modern JavaScript language features are used. Some browsers may still require polyfills.
#### Type Declarations
TypeScript declarations are generated from JavaScript and JSDoc:
```shell
npm run types
```
The command writes declarations to `types/` using the same directory structure as the JavaScript source.
#### License
This software is provided under the MIT license.