wishthis/node_modules/log-symbols/readme.md

52 lines
1.4 KiB
Markdown
Raw Normal View History

2022-06-08 10:36:39 +00:00
# log-symbols
<img src="screenshot.png" width="226" height="192" align="right">
> Colored symbols for various log levels
Includes fallbacks for Windows CMD which only supports a [limited character set](https://en.wikipedia.org/wiki/Code_page_437).
## Install
```
$ npm install log-symbols
```
## Usage
```js
const logSymbols = require('log-symbols');
console.log(logSymbols.success, 'Finished successfully!');
// Terminals with Unicode support: ✔ Finished successfully!
// Terminals without Unicode support: √ Finished successfully!
```
## API
### logSymbols
#### info
#### success
#### warning
#### error
## Related
- [figures](https://github.com/sindresorhus/figures) - Unicode symbols with Windows CMD fallbacks
- [py-log-symbols](https://github.com/ManrajGrover/py-log-symbols) - Python port
- [log-symbols](https://github.com/palash25/log-symbols) - Ruby port
- [guumaster/logsymbols](https://github.com/guumaster/logsymbols) - Golang port
---
<div align="center">
<b>
<a href="https://tidelift.com/subscription/pkg/npm-log-symbols?utm_source=npm-log-symbols&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
</b>
<br>
<sub>
Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
</sub>
</div>