Git Product home page Git Product logo

npm-request's Introduction

Typed Request

The type definition for request

LICENSE

MIT

Contributing

# Fork this repo
npm install

npm run watch

# add tests, make changes, pass tests ... then [ctrl+c]
npm run publish

Updating

Update typings.json/version to match the source version you are typing against. e.g. if you are creating typings for [email protected], then:

// typings.json
{
  "version": "3.5.0"
  // ...
}

npm-request's People

Contributors

corlobepy avatar demurgos avatar louy avatar

Watchers

 avatar  avatar

npm-request's Issues

Response.body missing

The typings state that the callback will be called with an IncomingMessage. However, request extends the interface so that it also has a body property

Fix request.jar

The request.jar method is missing CookieJar argument.

Argument is needed to use a custom cookie store:

request.jar(new FileCookieStore('cookies.json'));

CoreOptions.jar should allow booleans

The jar attribute in CoreOptions is now too strictly typed:

jar - If true, remember cookies for future use (or define your custom cookie jar; see examples section)

Documentation

It should be boolean | CookieJar

Comment typings with documentation

We should adopt the style of other typings and include the related documentation in the comments.
It would greatly help in providing context to the typings: it's convenient to jump straight to the definitions and read the doc. This would be a first step in the direction of integrating documentation.

It would also have prevented issues such as #3.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.