# rf-logger

> A simple logging utility with a save function.

Latest version **4.0.0** (published 2021-11-22) · ISC license · 0 weekly downloads

## Install

```sh
npm install rf-logger
pnpm add rf-logger
yarn add rf-logger
bun add rf-logger
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.0 |
| Published | 2021-11-22 |
| First published | 2020-10-08 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 10.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ryan Forever |
| Maintainers | surfingpikachu |

## Links

- npm: https://www.npmjs.com/package/rf-logger
- Repository: https://github.com/ryanfarber/rf-logger
- Homepage: https://github.com/ryanfarber/rf-logger#readme
- Issues: https://github.com/ryanfarber/rf-logger/issues
- npm.io page: https://npm.io/package/rf-logger

## Dependencies (2)

- [chalk](https://npm.io/package/chalk.md) ^4.1.2
- [time-stamp](https://npm.io/package/time-stamp.md) ^2.2.0

## Recent versions

- 4.0.0 (latest) — 2021-11-22
- 3.0.2 — 2020-10-31
- 3.0.1 — 2020-10-31
- 3.0.0 — 2020-10-31
- 2.1.0 — 2020-10-08

## README

# rf-logger

A simple logging utility with a save function.

### Setup
The first parameter takes a name or a label that will prefix the log.  Usually it's best to just use the name of whatever script is running the logger.
If you want to save, the logs to a file, use

`{ save: true }`.

It will default save to:

`./logs.log`.

Otherwise, you can specify the path in options:

```javascript 
const logger = new Logger({ filename: "myscript.js", save: false, path: "./logs.log" });
```
It will save with timestamps in CSV format.

Timestamp format: `YYMMDD HH:mm:ss.ms`

If you want to import it to a spreadsheet, just change the extension `.log` to `.csv`.

### Custom Log Name
You can add a custom log name by adding it to settings. 
```javascript 
const logger = new Logger({ filename: "myscript.js", customLog: "fatality"});

logger.custom("this might be bad")
// (myscript.js) FATALITY this might be bad
```

### Example
```javascript
const Logger = require("./index.js");
const logger = new Logger({ filename: "myscript.js", save: false, path: "./logs.log", customLog: "fatality" });

logger.log("hello world")
// (myscript.js) hello world 

logger.info("hello info")
// (myscript.js) <INFO> hello info

logger.warn("hello warning")
// (myscript.js) <WARN> hello warning

logger.error("hello error")
// (myscript.js) <ERROR> hello error

logger.debug("hello debug")
// (myscript.js) <DEBUG> hello debug

logger.custom("hello custom")
// (myscript.js) <FATALITY> hello custom
```

### Saved Output
```
200803 00:16:54.436, "myscript.js", log, "hello world"
200803 00:16:54.436, "myscript.js", info, "hello info"
200803 00:16:54.436, "myscript.js", error, "hello error"
200803 00:16:54.436, "myscript.js", warn, "hello warning"
200803 00:16:54.436, "myscript.js", fatality, "hello custom"
```

---
_Source: https://npm.io/package/rf-logger · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._