https://github.com/link-society/easylog
Simple and minimalist logging library
https://github.com/link-society/easylog
logging typescript
Last synced: about 1 month ago
JSON representation
Simple and minimalist logging library
- Host: GitHub
- URL: https://github.com/link-society/easylog
- Owner: link-society
- License: mit
- Created: 2021-03-04T00:08:35.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2022-12-08T07:05:21.000Z (over 3 years ago)
- Last Synced: 2025-02-19T01:49:37.023Z (over 1 year ago)
- Topics: logging, typescript
- Language: TypeScript
- Size: 135 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# easylog
EasyLog is a very simple and minimalist logging library. It exists because this
code was copied/pasted in almost every project we maintain.
## Installation
```
$ yarn add @link-society/easylog
```
## Usage
**In TypeScript:**
```typescript
import logging, { LogLevel } from '@link-society/easylog'
logging.configure({
level: LogLevel.Info
})
logging.debug({ foo: 'bar' }) // will not be printed
logging.info({ foo: 'bar' }) // will be printed
```
**In NodeJS:**
```javascript
const { default: logging, LogLevel } = require('@link-society/easylog')
logging.configure({
level: LogLevel.Info
})
logging.debug({ foo: 'bar' }) // will not be printed
logging.info({ foo: 'bar' }) // will be printed
```
## API
The methods `debug`, `info` and `warn` accepts a `LogRecord` object, it is an
object whose properties are either a `string`, a `number` or a `boolean`.
The method `error` accepts an `Error` object and and will generate the
`LogRecord` object.
The method `configure` accepts an object with the following properties:
| Name | Type | Description |
|---|---|---|
| `level` | `Optional` | Minimum logging level required to be written to the output |
| `writer` | `Optional` | Object used to write the output (example: `console`) |
| `processor` | `Optional` | Function used to transform the log record before writing it |
| `errorProcessor` | `Optional` | Function used to generate the log record from an error |
## License
This library is released under the terms of the [MIT License](./LICENSE.txt).