Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xambassador/chrona
Simple HTTP request logger middleware for express.js inspired from koa-logger, written in typescript.
https://github.com/xambassador/chrona
api chalk express http-logger javascript koa logger logger-middleware middleware minimal nodejs typescript
Last synced: 29 days ago
JSON representation
Simple HTTP request logger middleware for express.js inspired from koa-logger, written in typescript.
- Host: GitHub
- URL: https://github.com/xambassador/chrona
- Owner: xambassador
- License: mit
- Created: 2023-08-12T19:49:09.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-26T12:19:08.000Z (10 months ago)
- Last Synced: 2024-10-01T02:04:43.845Z (about 1 month ago)
- Topics: api, chalk, express, http-logger, javascript, koa, logger, logger-middleware, middleware, minimal, nodejs, typescript
- Language: TypeScript
- Homepage:
- Size: 451 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# chrona
Simple HTTP request logger middleware for express.js inspired by [koa-logger](https://github.com/koajs/logger), written in typescript.
## Installation
This is a [Node.js](https://nodejs.org/en/) module available through the [npm registry](https://www.npmjs.com/). Installation is done using the
[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
```sh
$ npm install chrona
```
## API
```js
var chrona = require('chrona')
app.use(chrona())
```
> Make sure to add chrona to first in middleware chain.
### chrona(format, options)
Create a new chrona middleware function using the given `format` and `options`. By default, it creates with default `format` and default `options` value.
The `format` argument is a string of predefined token names(see below for token names).
#### Predefined token names.
- :incoming
- :[incoming]
- :remote-address
- :[remote-address]
- :date
- :[date]
- :method
- :[method]
- :url
- :[url]
- :http-version
- :[http-version]
- :status
- :[status]
- :content-length
- :[content-length]
- :response-time
- :[response-time]
- :referrer
- :[referrer]
- :user-agent
- :[user-agent]
> :incoming is special one, If format string contains it, it add directional arrows(`-->`) for incoming request and outgoing response in log string.
### Using a predefined format string
```js
app.use(chrona(":incoming :method :url :status :response-time :content-length :user-agent :http-version"))
```
### options
chroma accepts options argument as a function or an object. Right now chroma has only one option call transporter which can be provided
either by passing function or an object with transporter key. Transporter is for change chrona's default transporter(where to show log messages)
which is `console.log`.
### Use Custom Transporter
```js
// If you want to go with default format string, then just pass
// empty string or null
app.use(chrona(null, function(str, args) => {
// pass str and args to your own transporter like winston etc.
}))
```