UNPKG

@smithy/middleware-endpoint

Version:

[![NPM version](https://img.shields.io/npm/v/@smithy/middleware-endpoint/latest.svg)](https://www.npmjs.com/package/@smithy/middleware-endpoint) [![NPM downloads](https://img.shields.io/npm/dm/@smithy/middleware-endpoint.svg)](https://www.npmjs.com/packag

29 lines (28 loc) 1.87 kB
import type { EndpointParameters, EndpointV2, HandlerExecutionContext } from "@smithy/types"; import type { EndpointResolvedConfig } from "../resolveEndpointConfig"; import type { EndpointParameterInstructions } from "../types"; /** * @internal */ export type EndpointParameterInstructionsSupplier = Partial<{ getEndpointParameterInstructions(): EndpointParameterInstructions; }>; /** * This step in the endpoint resolution process is exposed as a function * to allow packages such as signers, lib-upload, etc. to get * the V2 Endpoint associated to an instance of some api operation command * without needing to send it or resolve its middleware stack. * * @internal * @param commandInput - the input of the Command in question. * @param instructionsSupplier - this is typically a Command constructor. A static function supplying the * endpoint parameter instructions will exist for commands in services * having an endpoints ruleset trait. * @param clientConfig - config of the service client. * @param context - optional context. */ export declare const getEndpointFromInstructions: <T extends EndpointParameters, CommandInput extends Record<string, unknown>, Config extends Record<string, unknown>>(commandInput: CommandInput, instructionsSupplier: EndpointParameterInstructionsSupplier, clientConfig: Partial<EndpointResolvedConfig<T>> & Config, context?: HandlerExecutionContext) => Promise<EndpointV2>; /** * @internal */ export declare const resolveParams: <T extends EndpointParameters, CommandInput extends Record<string, unknown>, Config extends Record<string, unknown>>(commandInput: CommandInput, instructionsSupplier: EndpointParameterInstructionsSupplier, clientConfig: Partial<EndpointResolvedConfig<T>> & Config) => Promise<EndpointParameters>;