# deep-seas-logger

> a light wrapper around winston that is configurable via node ENV variables

Latest version **1.0.1** (published 2023-08-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install deep-seas-logger
pnpm add deep-seas-logger
yarn add deep-seas-logger
bun add deep-seas-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 | 1.0.1 |
| Published | 2023-08-03 |
| First published | 2023-08-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 23.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | theurbanwarlord |

## Links

- npm: https://www.npmjs.com/package/deep-seas-logger
- npm.io page: https://npm.io/package/deep-seas-logger

## Dependencies (1)

- [winston](https://npm.io/package/winston.md) ^3.10.0

## Recent versions

- 1.0.1 (latest) — 2023-08-03
- 1.0.0 — 2023-08-03

## README

# Project Title

The purpose of this project is to provide a wrapper around the incredible winston library that will automatically configure a few things that I find I configure a lot and would rather have come standard in the library, especially configuring Winston's metadata via Environment variables.

## Getting Started

1. Install the deep-seas-logger via either javascript dependency manager you would like: `yarn add deep-seas-logger` or `npm install deep-seas-logger`
2. Ensure that you have set the node environment variables associated with this logger:
  1. APP_NAME
  2. DOMAIN
  3. NODE_ENV
  4. USER_ID
  5. PLATFORM
3. Then import the createLogger function anywhere you would like to use it: `import { createLogger } from '../../index';`
4. You can now build an instance of the logger by invoking createLogger: `const logger = createLogger()`

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