UNPKG

@aws-sdk/middleware-user-agent

Version:

[![NPM version](https://img.shields.io/npm/v/@aws-sdk/middleware-user-agent/latest.svg)](https://www.npmjs.com/package/@aws-sdk/middleware-user-agent) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/middleware-user-agent.svg)](https://www.npmjs.c

18 lines (17 loc) 1.16 kB
import { AbsoluteLocation, BuildHandler, BuildHandlerOptions, HandlerExecutionContext, MetadataBearer, Pluggable } from "@smithy/types"; import { UserAgentResolvedConfig } from "./configurations"; /** * Build user agent header sections from: * 1. runtime-specific default user agent provider; * 2. custom user agent from `customUserAgent` client config; * 3. handler execution context set by internal SDK components; * The built user agent will be set to `x-amz-user-agent` header for ALL the * runtimes. * Please note that any override to the `user-agent` or `x-amz-user-agent` header * in the HTTP request is discouraged. Please use `customUserAgent` client * config or middleware setting the `userAgent` context to generate desired user * agent. */ export declare const userAgentMiddleware: (options: UserAgentResolvedConfig) => <Output extends MetadataBearer>(next: BuildHandler<any, any>, context: HandlerExecutionContext) => BuildHandler<any, any>; export declare const getUserAgentMiddlewareOptions: BuildHandlerOptions & AbsoluteLocation; export declare const getUserAgentPlugin: (config: UserAgentResolvedConfig) => Pluggable<any, any>;