Logo for jsDocs.io

@types/request-promise

  • Version 4.1.51
  • Published
  • 6.22 kB
  • 2 dependencies
  • MIT license

Install

npm i @types/request-promise
yarn add @types/request-promise
pnpm add @types/request-promise

Overview

TypeScript definitions for request-promise

Index

Variables

Interfaces

Type Aliases

Variables

variable requestPromise

const requestPromise: request.RequestAPI<
    requestPromise.RequestPromise<T>,
    requestPromise.RequestPromiseOptions,
    request.RequiredUriUrl
>;

    Interfaces

    interface RequestPromise

    interface RequestPromise<T = any> extends request.Request {}

      property cancel

      cancel: Promise<T>['cancel'];

        property catch

        catch: Promise<T>['catch'];

          property finally

          finally: Promise<T>['finally'];

            property then

            then: Promise<T>['then'];

              method promise

              promise: () => Promise<T>;

                interface RequestPromiseOptions

                interface RequestPromiseOptions extends request.CoreOptions {}

                  property resolveWithFullResponse

                  resolveWithFullResponse?: boolean | undefined;

                    property simple

                    simple?: boolean | undefined;

                      property transform2xxOnly

                      transform2xxOnly?: boolean | undefined;

                        method transform

                        transform: (
                            body: any,
                            response: request.Response,
                            resolveWithFullResponse?: boolean
                        ) => any;

                          Type Aliases

                          type Options

                          type Options = OptionsWithUri | OptionsWithUrl;

                            type OptionsWithUri

                            type OptionsWithUri = request.UriOptions & RequestPromiseOptions;

                              type OptionsWithUrl

                              type OptionsWithUrl = request.UrlOptions & RequestPromiseOptions;

                                type RequestPromiseAPI

                                type RequestPromiseAPI<T = any> = request.RequestAPI<
                                    RequestPromise<T>,
                                    RequestPromiseOptions,
                                    request.RequiredUriUrl
                                >;

                                  Package Files (1)

                                  Dependencies (2)

                                  Dev Dependencies (0)

                                  No dev dependencies.

                                  Peer Dependencies (0)

                                  No peer dependencies.

                                  Badge

                                  To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                  You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/request-promise.

                                  • Markdown
                                    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/request-promise)
                                  • HTML
                                    <a href="https://www.jsdocs.io/package/@types/request-promise"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>