UNPKG

motion-lib

Version:

This document describes the management of vulnerabilities for the project and all modules within the organization.

89 lines (56 loc) 2.54 kB
# motion-lib [![npm version](https://img.shields.io/npm/v/pino)](https://www.npmjs.com/package/pino) [![Build Status](https://img.shields.io/github/actions/workflow/status/pinojs/pino/ci.yml)](https://github.com/pinojs/pino/actions) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/) ## Install Using NPM: ``` $ npm install motion-lib ``` Using YARN: ``` $ yarn add motion-lib ``` ## Usage ```js import chai from 'chai' import motionLib from 'motion-lib'; chai.use((_chai, utilsLib) => { ... }) chai.use(motionLib) chai.should() ``` <a name="essentials"></a> ## Essentials ### Development Formatting The module can be used to format logs during development: ### Transports & Log Processing Due to Node's single-threaded event-loop, it's highly recommended that sending, alert triggering, reformatting, and all forms of log processing are conducted in a separate process or thread. In Pino terminology, we call all log processors "transports" and recommend that the transports be run in a worker thread using our `pino.transport` API. For more details see our [Transports⇗](docs/transports.md) document. ### Low overhead Using minimum resources for logging is very important. Log messages tend to get added over time and this can lead to a throttling effect on applications – such as reduced requests per second. In many cases, Pino is over 5x faster than alternatives. See the [Benchmarks](docs/benchmarks.md) document for comparisons. ### Bundling support Pino supports being bundled using tools like webpack or esbuild. See [Bundling](docs/bundling.md) document for more information. ## Contributing Pino is an **OPEN Open Source Project**. This means that: > Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project. See the [CONTRIBUTING.md](https://github.com/pinojs/pino/blob/main/CONTRIBUTING.md) file for more details. <a name="acknowledgments"></a> ## Acknowledgments This project was kindly sponsored by [nearForm](https://nearform.com). This project is kindly sponsored by [Platformatic](https://platformatic.dev). Logo and identity designed by Cosmic Fox Design: https://www.behance.net/cosmicfox. ## License Licensed under [MIT](./LICENSE). [elasticsearch]: https://www.elastic.co/products/elasticsearch [kibana]: https://www.elastic.co/products/kibana