Logo for jsDocs.io

@types/request-promise-native

  • Version 1.0.21
  • Published
  • 5.39 kB
  • 1 dependency
  • MIT license

Install

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

Overview

TypeScript definitions for request-promise-native

Index

Variables

Interfaces

Type Aliases

Variables

variable requestPromise

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

    Interfaces

    interface RequestPromise

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

      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 FullResponse

                  type FullResponse = request.Response;

                    type Options

                    type Options = OptionsWithUri | OptionsWithUrl;

                      type OptionsWithUri

                      type OptionsWithUri = request.UriOptions & RequestPromiseOptions;

                        type OptionsWithUrl

                        type OptionsWithUrl = request.UrlOptions & RequestPromiseOptions;

                          type RequestPromiseAPI

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

                            Package Files (1)

                            Dependencies (1)

                            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-native.

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