# @component-controls/logger
> compilation logging utilities
Latest version **4.0.3** (published 2022-01-14) · MIT license · 0 weekly downloads
## Install
```sh
npm install @component-controls/logger
pnpm add @component-controls/logger
yarn add @component-controls/logger
bun add @component-controls/logger
```
## Health
**Score 30/100 (F)** — status: abandoned.
Positive: has types; esm support; no vulnerabilities; high quality score.
Warnings: low downloads.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 4.0.3 |
| Published | 2022-01-14 |
| First published | 2020-08-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 10.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 82 |
| Maintainers | atanasster |
## Links
- npm: https://www.npmjs.com/package/@component-controls/logger
- Repository: https://github.com/ccontrols/component-controls
- Issues: https://github.com/ccontrols/component-controls/issues
- npm.io page: https://npm.io/package/@component-controls/logger
## Dependencies (1)
- [chalk](https://npm.io/package/chalk.md) ^4.0.0
## Recent versions
- 4.0.3 (latest) — 2022-01-14
- 3.10.0 — 2021-05-08
- 3.8.2 — 2021-04-30
- 3.8.0 — 2021-04-29
- 2.10.4 — 2021-02-28
- 2.8.0 — 2021-02-18
- 2.6.0 — 2021-01-07
- 2.5.0 — 2020-12-28
- 2.2.0 — 2020-12-08
- 2.0.0 — 2020-12-05
- 1.37.0 — 2020-11-01
- 1.36.8 — 2020-10-29
- 1.22.0 — 2020-08-28
## README
# Table of contents
- [Overview](#overview)
- [Installation](#installation)
- [API](#api)
- [LogLevel](#loglevel)
- [LogOptions](#logoptions)
- [log](#log)
- [error](#error)
- [setLogOptions](#setlogoptions)
# Overview
Logging utilities. Uses the [chalk](https://github.com/chalk/chalk#readme) package for logging output
# Installation
This package is usually installed as part of the @component-controls package, but you can also install it standalone:
```bash
$ npm install @component-controls/logger --save-dev
```
# API
## LogLevel
**`union`**
_defined in [@component-controls/logger/core/logger/src/index.ts](https://github.com/ccontrols/component-controls/tree/master/core/logger/src/index.ts#L3)_
**values**
`"all"` \| `"errors"` \| `"none"`
## LogOptions
**`interface`**
_defined in [@component-controls/logger/core/logger/src/index.ts](https://github.com/ccontrols/component-controls/tree/master/core/logger/src/index.ts#L5)_
**properties**
| Name | Type |
| ---------- | ------------------------------- |
| `logLevel` | [`LogLevel`](#loglevel) |
| `colors*` | \[`number`, `number`, `number`] |
## log
**`function`**
_defined in [@component-controls/logger/core/logger/src/index.ts](https://github.com/ccontrols/component-controls/tree/master/core/logger/src/index.ts#L28)_
**parameters**
| Name | Type |
| ---------- | ------------------------------- |
| `heading*` | `string` |
| `text*` | `string` |
| `bgColor` | \[`number`, `number`, `number`] |
## error
**`function`**
_defined in [@component-controls/logger/core/logger/src/index.ts](https://github.com/ccontrols/component-controls/tree/master/core/logger/src/index.ts#L37)_
**parameters**
| Name | Type |
| ---------- | ------------------------------- |
| `heading*` | `string` |
| `text*` | `string` |
| `bgColor` | \[`number`, `number`, `number`] |
## setLogOptions
**`function`**
_defined in [@component-controls/logger/core/logger/src/index.ts](https://github.com/ccontrols/component-controls/tree/master/core/logger/src/index.ts#L47)_
**parameters**
| Name | Type |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `options*` | `Partial`
`logLevel`: [`LogLevel`](#loglevel)
`colors`\*: \[`number`, `number`, `number`]