# axios-nice-log

> Axios interceptor logger for requests query parameters

Latest version **0.1.10** (published 2021-03-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install axios-nice-log
pnpm add axios-nice-log
yarn add axios-nice-log
bun add axios-nice-log
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.10 |
| Published | 2021-03-01 |
| First published | 2020-12-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 10.8 KB |
| Known vulnerabilities | 0 (+24 in 1 direct dependencies) |
| Install scripts | no |
| Author | reslear |
| Maintainers | reslear |
| Keywords | log, axios, logging, chalk |

## Links

- npm: https://www.npmjs.com/package/axios-nice-log
- Repository: https://github.com/whalest/axios-nice-log
- Issues: https://github.com/whalest/axios-nice-log/issues
- npm.io page: https://npm.io/package/axios-nice-log

## Dependencies (5)

- [qs](https://npm.io/package/qs.md) ^6.7.0
- [axios](https://npm.io/package/axios.md) 0.21.1
- [chalk](https://npm.io/package/chalk.md) 4.1.0
- [@types/qs](https://npm.io/package/@types/qs.md) ^6.9.5
- [chalk-pipe](https://npm.io/package/chalk-pipe.md) ^4.0.0

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 0.1.10 (latest) — 2021-03-01
- 0.1.9 — 2021-03-01
- 0.1.8 — 2021-03-01
- 0.1.7 — 2021-02-25
- 0.1.6 — 2021-02-25
- 0.1.5 — 2021-02-25
- 0.1.4 — 2021-02-25
- 0.1.2 — 2021-02-24
- 0.1.1 — 2021-02-24
- 0.0.4 — 2020-12-23
- 0.0.3 — 2020-12-23
- 0.0.2 — 2020-12-23
- 0.0.1 — 2020-12-23

## README

# axios-nice-log

Axios interceptor logger for requests query parameters for humans 😜

<img  src="https://raw.githubusercontent.com/whalest/axios-nice-log/main/media/thumb.png"  width="584">

- many options customizable
- set global defaults
- styles by [chalk](https://github.com/chalk/chalk)
- lightweight \~2kb

## Setup

```sh
npm i axios-nice-log
```

## Usage

basic

```ts
import axios from 'axios'
import axiosNiceLog from 'axios-nice-log'

axios.interceptors.request.use(axiosNiceLog)
```

local option

```ts
import axios from 'axios'
import { axiosNiceLog, setAxiosNiceLog } from 'axios-nice-log'

// global options
setAxiosNiceLog({
  prefix: 'my',
})

// local options
axios.interceptors.request.use((config) =>
  axiosNiceLog(config, {
    prefix: 'custom',
  })
)
```

## Api

Options

| **Option** | **Type** | **Default**                         | **description**                                                            |
| ---------- | -------- | ----------------------------------- | -------------------------------------------------------------------------- |
| prefix     | string   | "axios"                             | Line prefix                                                                |
| styles     | object   | [styles default](#styles)           | template parts styles                                                      |
| template   | string   | "%prefix %time %method %url%params" | line template parts available <br>(**%prefix %time %method %url %params**) |
| templates  | object   | [templates default](#tempaltes)     | template parts value <br>**%s** - value replaced                           |
| logger     | callback | console.log                         | logger function                                                            |

### [styles default](#styles)

```ts
{
	prefix: "green",
	time: "reset",
	method: "yellow",
	url: "cyan",
	params: "reset",
	separator: "yellow",
	delimiter: "gray",
}
```

### [templates default](#templates)

```ts
{
    prefix: "[%s]",
    time: "%s",
    method: "%s",
    url: "%s",
    params: "%s",
    separator: "?",
    delimiter: "=",
  }
```

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