https://github.com/mediafellows/superdebug
A simple debugging log for superagent
https://github.com/mediafellows/superdebug
fork library tooling
Last synced: 11 months ago
JSON representation
A simple debugging log for superagent
- Host: GitHub
- URL: https://github.com/mediafellows/superdebug
- Owner: mediafellows
- Created: 2020-04-03T10:23:07.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-04-06T14:12:55.000Z (over 6 years ago)
- Last Synced: 2025-04-04T00:44:44.651Z (over 1 year ago)
- Topics: fork, library, tooling
- Language: JavaScript
- Homepage: https://github.com/andineck/superdebug
- Size: 564 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Debug Superagent Requests - generates curl output
- logging for [superagent](https://github.com/visionmedia/superagent)
- logs in curl format
- let's you copy&paste the curl output to send to someone else
- works with node.js and in the browser with browserify or webpack
- only dependency is [debug](https://github.com/visionmedia/debug)
- works with sent `data` and `formData`
-----------
### Install
```cli
npm i -S superdebug
```
### Usage
```js
let superagent = require('superagent');
let superdebug = require('superdebug');
superagent('GET', 'http://localhost:3000/debug')
.set({Accept: 'application/json'})
.query({superdebug: 'is-awesome'})
.use(superdebug(console.info))
.timeout(10000)
.send()
.end()
```
### Output Log
```log
super-curl curl -v -X GET -H 'User-Agent: node-superagent/3.3.2' -H 'Accept: application/json' http://localhost:3000/debug?superdebug=is-awesome +0ms
super-debug HTTP GET 200 http://localhost:3000/debug?superdebug=is-awesome (23ms) +25ms
```
### Using Debug
```
DEBUG=super-* node test/test-server.js
```
output with json data
### Options
- you can call `superdebug()` without arguments -> produces only log output with set `DEBUG` environment variable:
- examples: `DEBUG=super-curl` or `DEBUG=super-debug`
- or you can call `superdebug(console.info)` with your preferred logger e.g. `console.info`
```js
superagent('GET', 'http://localhost:3000/debug')
.use(superdebug())
```
### Test
run:
```sh
npm test
```
### License
MIT
### Credits
- https://github.com/sebastianlzy/superagent-debugger