Installations

npm install @redtea/format-axios-error

Score

88.7

Supply Chain

99.5

Quality

75.2

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

1

Closed

0

Merged

1

Issues

Open

0

Total

0

Closed

0

Releases

1

v2.1.1

Published on 24 Jan 2023

View all 1 releases

Developer

org-redtea

Developer Guide

BETA

Module System

CommonJS, ESM, UMD

Min. Node Version

Typescript Support

Yes

Node Version

NPM Version

Statistics

4 Stars

19 Commits

1 Forks

2 Watching

1 Branches

2 Contributors

Updated on 09 Jul 2024

Languages

TypeScript (86.66%)

JavaScript (13.34%)

Total Downloads

Cumulative downloads

Total Downloads

968,359

Last day

-58.6%

1,601

Compared to previous day

Last week

-23%

9,345

Compared to previous week

Last month

26.7%

55,825

Compared to previous month

Last year

123.4%

554,811

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

1

logform

Dev Dependencies

19

@babel/core @babel/preset-env @rollup/plugin-babel @rollup/plugin-commonjs @rollup/plugin-node-resolve @rollup/plugin-replace @skypack/package-check @types/chai @types/expect @types/mocha @types/triple-beam axios axios-mock-adapter chai mocha rollup shx ts-mocha typescript

Versions

@redtea/format-axios-error

This is a small library that provides a function to format an axios error object for logging purposes. It strips any unnecessary information from the error object, making it more readable and easy to understand when reviewing logs.

Can be used with logform and winston.

Installation

Yarn

1$ yarn add -E @redtea/format-axios-error

NPM

1$ npm install -E @redtea/format-axios-error

Usage

More usage examples can be found in examples directory.

NodeJS

1const axios = require('axios');
2const {format} = require('@redtea/format-axios-error');
3
4axios
5  .get('https://google.com/give-404')
6  .catch(error => {
7    console.log(
8      JSON.stringify(format(error), null, 2)
9    )
10  });

will print

{
  "name": "Error",
  "isAxiosError": true,
  "config": {
    "url": "https://google.com/give-404",
    "method": "get",
    "headers": [headers],
    "timeout": 0,
    "xsrfCookieName": "XSRF-TOKEN",
    "xsrfHeaderName": "X-XSRF-TOKEN",
    "maxContentLength": -1,
    "maxBodyLength": -1
  },
  "response": {
    "data": [data],
    "status": 404,
    "statusText": "Not Found",
    "headers": [headers]
  }
}

In the example, response data and headers are omitted. Run the code snipped locally to see full log output.

How to use with winston and logform

1const winston = require('winston');
2const axios = require('axios');
3const {axiosError} = require('@redtea/format-axios-error/logform');
4const {combine, json} = winston.format;	
5
6const logger = winston.createLogger({
7  level: 'info',
8  format: combine(
9    axiosError(),
10    json({ space: 2 })
11  ),
12  transports: [
13    new winston.transports.Console(),
14  ],
15});
16
17axios
18  .get('https://google.com/give-404')
19  .catch(error => logger.error(error))

will print

{
  "config": {
    "url": "https://google.com/give-404",
    "method": "get",
    "headers": [headers],
    "timeout": 0,
    "xsrfCookieName": "XSRF-TOKEN",
    "xsrfHeaderName": "X-XSRF-TOKEN",
    "maxContentLength": -1,
    "maxBodyLength": -1
  },
  "isAxiosError": true,
  "level": "error",
  "response": {
    "status": 404,
    "data": [data],
    "headers": [headers],
    "statusText": "Not Found"
  },
  "message": "Request failed with status code 404"
}

Browser

1<!DOCTYPE html>
2<html lang="en">
3<head>
4  <meta charset="UTF-8">
5  <title>format-axios-error browser example</title>
6  <script src="https://unpkg.com/axios" type="application/javascript"></script>
7  <script src="https://unpkg.com/@redtea/format-axios-error" type="application/javascript"></script>
8</head>
9<body>
10<script>
11  axios
12    .get('https://www.googleapis.com/give-404')
13    .catch(error => {
14      console.log(
15        JSON.stringify(
16          AxiosErrorFormat.format(error),
17          null,
18          2
19        )
20      )
21    })
22</script>
23</body>
24</html>

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

License

Determines if the project has defined a license.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

43 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-4w2v-q235-vp99
Warn: Project is vulnerable to: GHSA-cph5-m8f7-6c5x
Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx
Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-4q6p-r6v2-jvc5
Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-qrpm-p2h7-hrv2
Warn: Project is vulnerable to: GHSA-g6ww-v8xp-vmwg
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj

Score

1.3

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More