# my-request

> Request module based on superagent and supertest

Latest version **1.0.0** (published 2015-03-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install my-request
pnpm add my-request
yarn add my-request
bun add my-request
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2015-03-03 |
| First published | 2015-03-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Luis Valdovinos |
| Maintainers | lvaldovinos |
| Keywords | request, superagent, supertest |

## Links

- npm: https://www.npmjs.com/package/my-request
- Repository: https://github.com/lvaldovinos/my-request
- Issues: https://github.com/lvaldovinos/my-request/issues
- npm.io page: https://npm.io/package/my-request

## Dependencies (3)

- [methods](https://npm.io/package/methods.md) ^1.1.1
- [superagent](https://npm.io/package/superagent.md) ^0.21.0
- [underscore](https://npm.io/package/underscore.md) ^1.8.2

## Recent versions

- 1.0.0 (latest) — 2015-03-03

## README

# my-request
Request module based on superagent and supertest

<h2>Installation</h2>

  <code>
    npm install my-request
  </code>

<h2>Example code</h2>

<p>Inspired by Supertest and Superagent, my-request uses the same logic than supertest to do a request <strong>example:</strong></p>

```javascript
  var request = require('my-request'),
      myRequest = request.init('http://alonso-thoughtsapi.rhcloud.com');
  
  myRequest
    .get('/')
    .end(function(res) {
      console.log(res.body); // { hello: 'world' }
    });
```

<h2>API</h2>

<h4>#setPermanent(header)</h4>

<p>
  Method that helps you set a header permanently, you set the header once, and it will remain on next requests
</p>

<strong>Arguments</strong>

<p><code>header</code> This is an object like this one:</p>

```json
  { "Authorization" : "Bearer dasasdas123qasd1.12312asdads12.da123",
    "Localization" : "http://www.example.com/resource/id"
  }
```

<strong>Example</strong>
```javascript
  var request = require('my-request'),
      myRequest = request.init('http://alonso-thoughtsapi.rhcloud.com');
  
  myRequest
    .setPermanent({ Authorization : 'example-token' })
    .get('/')
    .end(function(res) {
      console.log(res.req._headers.authorization); //'example-token'
    });
    
  myRequest
    .get('/blogs')
    .end(function(res) {
      console.log(res.req._headers.authorization); //'example-token'
    });
```

<h4>#unsetPermanent()</h4>

<p>
  Method that removes all permanent headers.
</p>

<strong>Example</strong>
```javascript
  var request = require('my-request'),
      myRequest = request.init('http://alonso-thoughtsapi.rhcloud.com');
  
  myRequest
    .setPermanent({ Authorization : 'example-token',
                    Localization : 'example-loc' })
    .get('/')
    .end(function(res) {
      console.log(res.req._headers.authorization); //'example-token'
      console.log(res.req._headers.localization); //'example-loc'
    });
    
  myRequest.unsetPermanent();
  myRequest
    .get('/blogs')
    .end(function(res) {
      console.log(res.req._headers.authorization); //'undefined'
      console.log(res.req._headers.localization); //'undefined'
    });
```

<h2>Test</h2>

<code>npm test</code>

<h2>License</h2>

The MIT License (MIT)

Copyright (c) 2015 Luis Alonso Valdovinos Valencia

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

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