Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hg-pyun/axios-logger
Beautify Axios Logging Messages
https://github.com/hg-pyun/axios-logger
axios javascript logger nodejs pretty
Last synced: 26 days ago
JSON representation
Beautify Axios Logging Messages
- Host: GitHub
- URL: https://github.com/hg-pyun/axios-logger
- Owner: hg-pyun
- License: mit
- Created: 2018-06-05T09:33:47.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-11T22:01:10.000Z (2 months ago)
- Last Synced: 2024-10-04T10:44:41.634Z (about 1 month ago)
- Topics: axios, javascript, logger, nodejs, pretty
- Language: JavaScript
- Homepage:
- Size: 919 KB
- Stars: 170
- Watchers: 3
- Forks: 33
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# axios-logger
[](https://www.npmjs.com/package/axios-logger)
[](https://www.npmjs.com/package/axios-logger)
[](https://github.com/hg-pyun/axios-logger/blob/master/LICENSE)
[](https://circleci.com/gh/hg-pyun/axios-logger/tree/master)
> Beautify Axios Logging Messages.
When you send a request in nodejs, you need to show the log to the console.
This library display the necessary information while communicating with the server.
Basically This package is working as [Axios's interceptors](https://github.com/axios/axios#interceptors).
## Install
```
$ npm install axios-logger --save-dev
```
## How to use
You can use various loggers through the `axios`'s interceptor API.
### Logging Request
```javascript
import axios from 'axios';
import * as AxiosLogger from 'axios-logger';
const instance = axios.create();
instance.interceptors.request.use(AxiosLogger.requestLogger);
```
If you want to use your own interceptor, you can compose(mixin) with `requestLogger`.
```javascript
instance.interceptors.request.use((request) => {
// write down your request intercept.
return AxiosLogger.requestLogger(request);
});
```
### Logging Response
```javascript
import axios from 'axios';
import * as AxiosLogger from 'axios-logger';
const instance = axios.create();
instance.interceptors.response.use(AxiosLogger.responseLogger);
```
Also if you want to use your own interceptor, you can compose(mixin) with `responseLogger`.
```javascript
instance.interceptors.response.use((response) => {
// write down your response intercept.
return AxiosLogger.responseLogger(response);
});
```
### Error
You can inject `errorLogger` right after `requestLogger` or `responseLogger`.
```javascript
import axios from 'axios';
import * as AxiosLogger from 'axios-logger';
const instance = axios.create();
instance.interceptors.request.use(AxiosLogger.requestLogger, AxiosLogger.errorLogger);
instance.interceptors.response.use(AxiosLogger.responseLogger, AxiosLogger.errorLogger);
```
Also if you want to use your own interceptor, you can compose(mixin) with `errorLogger`.
```javascript
instance.interceptors.response.use(AxiosLogger.responseLogger, (err) => {
// write down your error intercept.
return AxiosLogger.errorLogger(err);
});
```
## Configuration Settings
You can adjust several features as desired through configuration file.
If you want to set config globally, using `setGlobalConfig` method.
```javascript
setGlobalConfig({
prefixText: 'your prefix',
dateFormat: 'HH:MM:ss',
status: false,
headers: true,
logger: someLogger.info.bind(this),
});
```
Or it can also be passed on as a second argument and applied locally. In this case, any property explicitly defined will
override the global configuration.
```javascript
instance.interceptors.request.use((request) => {
// write down your request intercept.
return AxiosLogger.requestLogger(request, {
prefixText: 'your prefix',
dateFormat: 'HH:MM:ss',
status: false,
headers: true,
logger: someLogger.error.bind(this),
});
});
```
#### Enable config list
| Property | Type | Default | Description |
| ------------ | ------------------------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `method` | boolean | `true` | Whether to include HTTP method or not. |
| `url` | boolean | `true` | Whether to include the URL or not. |
| `params` | boolean | `false` | Whether to include the URL params or not. |
| `data` | boolean | `true` | Whether to include request/response data or not. |
| `status` | boolean | `true` | Whether to include response statuses or not. |
| `statusText` | boolean | `true` | Whether to include response status text or not. |
| `headers` | boolean | `false` | Whether to include HTTP headers or not. |
| `prefixText` | string \| `false` | `'Axios'` | `false` => no prefix, otherwise, customize the prefix wanted. |
| `dateFormat` | [dateformat](https://github.com/felixge/node-dateformat) \| `false` | `false` | `false` => no timestamp, otherwise, customize its format |
| `logger` | function | `console.log` | Allows users to customize the logger function to be used. e.g. Winston's `logger.info` could be leveraged, like this: `logger.info.bind(this)` |
## CONTRIBUTE
I always welcome Feedback and Pull Request :)