Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
FreeWall committed Apr 1, 2023
1 parent fab6fc1 commit 780b7b8
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 6 deletions.
50 changes: 50 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Axios Console Logger

[![npm version](https://img.shields.io/npm/v/@freewall/axios-console-logger?color=blue)](https://www.npmjs.com/@freewall/axios-console-logger)
[![publish status](https://img.shields.io/github/actions/workflow/status/FreeWall/axios-console-logger/publish.yml)](https://github.com/FreeWall/axios-console-logger/releases/latest)

A console logger for Axios HTTP client.

## Installation

```shell
npm install @freewall/axios-console-logger
```

## Usage

```js
import { AxiosConsoleLogger } from '@freewall/axios-console-logger';

const logger = new AxiosConsoleLogger();

axios.interceptors.request.use((request) => logger.request(request));

axios.interceptors.response.use(
(response) => logger.response(response),
(error) => logger.error(error),
);
```

### Options

```js
// default values:
new AxiosConsoleLogger({
colors: {
get: {
request: '#54b7d3',
response: '#408ba1',
},
post: {
request: '#96c750',
response: '#6f943b',
},
},
multiline: false,
responseSize: true,
responseTime: true,
requestKeys: ['params', 'data'],
responseKeys: ['data'],
});
```
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@freewall/axios-console-logger",
"version": "0.1.0",
"version": "0.2.0",
"license": "MIT",
"author": "Michal Vaněk",
"private": false,
Expand Down Expand Up @@ -32,6 +32,7 @@
"axios-interceptor",
"http",
"logging",
"debug"
"debug",
"node"
]
}
4 changes: 2 additions & 2 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@ interface AxiosConsoleLoggerOptions {
response: string;
};
};
multiline?: boolean;
responseSize?: boolean;
responseTime?: boolean;
multiline?: boolean;
requestKeys?: RequestKey[];
responseKeys?: ResponseKey[];
}
Expand All @@ -64,9 +64,9 @@ export class AxiosConsoleLogger {
get: options?.colors?.get ?? defaultOptions?.colors?.get,
post: options?.colors?.post ?? defaultOptions?.colors?.post,
},
multiline: options?.multiline ?? defaultOptions.multiline,
responseSize: options?.responseSize ?? defaultOptions.responseSize,
responseTime: options?.responseTime ?? defaultOptions.responseTime,
multiline: options?.multiline ?? defaultOptions.multiline,
requestKeys: options?.requestKeys ?? defaultOptions.requestKeys,
responseKeys: options?.responseKeys ?? defaultOptions.responseKeys,
};
Expand Down

0 comments on commit 780b7b8

Please sign in to comment.