@aws-sdk/node-http-handler

  • Version 3.74.0
  • Published
  • 114 kB
  • 5 dependencies
  • Apache-2.0 license

Install

npm i @aws-sdk/node-http-handler
yarn add @aws-sdk/node-http-handler
pnpm add @aws-sdk/node-http-handler

Overview

Provides a way to make requests

Index

Variables

variable streamCollector

const streamCollector: StreamCollector;

    Classes

    class NodeHttp2Handler

    class NodeHttp2Handler implements HttpHandler {}

      constructor

      constructor({
      requestTimeout,
      sessionTimeout,
      disableConcurrentStreams,
      }?: NodeHttp2HandlerOptions);

        property metadata

        readonly metadata: { handlerProtocol: string };

          method destroy

          destroy: () => void;

            method handle

            handle: (
            request: HttpRequest,
            { abortSignal }?: HttpHandlerOptions
            ) => Promise<{ response: HttpResponse }>;

              class NodeHttpHandler

              class NodeHttpHandler implements HttpHandler {}

                constructor

                constructor(options?: any);

                  property metadata

                  readonly metadata: { handlerProtocol: string };

                    method destroy

                    destroy: () => void;

                      method handle

                      handle: (
                      request: HttpRequest,
                      { abortSignal }?: HttpHandlerOptions
                      ) => Promise<{ response: HttpResponse }>;

                        Interfaces

                        interface NodeHttp2HandlerOptions

                        interface NodeHttp2HandlerOptions {}
                        • Represents the http2 options that can be passed to a node http2 client.

                        property disableConcurrentStreams

                        disableConcurrentStreams?: boolean;
                        • Disables processing concurrent streams on a ClientHttp2Session instance. When set to true, the handler will create a new session instance for each request to a URL. **Default:** false. https://nodejs.org/api/http2.html#http2_class_clienthttp2session

                        property requestTimeout

                        requestTimeout?: number;
                        • The maximum time in milliseconds that a stream may remain idle before it is closed.

                        property sessionTimeout

                        sessionTimeout?: number;
                        • The maximum time in milliseconds that a session or socket may remain idle before it is closed. https://nodejs.org/docs/latest-v12.x/api/http2.html#http2_http2session_and_sockets

                        interface NodeHttpHandlerOptions

                        interface NodeHttpHandlerOptions {}
                        • Represents the http options that can be passed to a node http client.

                        property connectionTimeout

                        connectionTimeout?: number;
                        • The maximum time in milliseconds that the connection phase of a request may take before the connection attempt is abandoned.

                        property httpAgent

                        httpAgent?: hAgent;

                          property httpsAgent

                          httpsAgent?: hsAgent;

                            property socketTimeout

                            socketTimeout?: number;
                            • The maximum time in milliseconds that a socket may remain idle before it is closed.

                            Package Files (4)

                            Dependencies (5)

                            Dev Dependencies (7)

                            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/@aws-sdk/node-http-handler.

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