ts-lambda-api - v2.5.4
ts-lambda-api - v2.5.5
ts-lambda-api
Build REST API's using Typescript & AWS Lambda.
@@ -682,4 +682,4 @@AbstractInitialise all controllers and endpoints declared using decorators.
+AbstractrunRun using the passed event and context, ultimately should call the
processEvent method on the apiServer instance.
API Gateway or ALB request.
Request context.
The response.
-Context of an error thrown by an endpoint method.
+Context of an error thrown by an endpoint method.
Instances of this class are passed to error interceptors.
-Controller instance used to call endpoint method.
-Endpoint method defintion.
-Parameter values passed to the endpoint method.
-Error thrown by the endpoint method.
-HTTP request context.
-HTTP response context.
-Endpoint method defintion.
+Parameter values passed to the endpoint method.
+Error thrown by the endpoint method.
+HTTP request context.
+HTTP response context.
+Impementation of the ApiApp class that handles native
+
Impementation of the ApiApp class that handles native
AWS Lambda requests and can be used to provide a Lambda
function handler.
The run method is the function handler entrypoint.
OptionalappContainer: Container(Optional) InversifyJS IOC Container instance which can
build controllers and error interceptors, defaults to new Container using
autobind flag set to true if autoInjectionEnabled is true.
Protected ReadonlyapiProtectedapp(Optional) Application config to pass to lambda-api, defaults to new AppConfig.
Protectedapp(Optional) InversifyJS IOC Container instance which can
build controllers and error interceptors, defaults to new Container using
autobind flag set to true if autoInjectionEnabled is true. If you pass your own
instance autoInjectionEnabled must reflect the autobind flag passed to the Container.
Protectedauto(Optional) Is auto injection enabled in the IOC container? Defaults to true.
Protected Optional Readonlycontrollers(Optional) Paths to the directories that contain controller js files that
+
Protectedauto(Optional) Is auto injection enabled in the IOC container? Defaults to true.
Protected Optional Readonlycontrollers(Optional) Paths to the directories that contain controller js files that
declare controllers. Required if the default Container is used, or the
autoInjectionEnabled is set to true. Ignored if the autoInjectionEnabled
is set to false.
ProtectedinitialisedProtected ReadonlylogProtectedloggerConfigure the API instance from the lambda-api package.
ProtectedinitialisedProtected ReadonlylogProtectedloggerConfigure the API instance from the lambda-api package.
Function that takes an API instance as a parameter.
Configure the InversifyJS IOC Container instance.
Configure the InversifyJS IOC Container instance.
Function that takes a Container instance as a parameter.
Create a native AWS Lambda handler that passes the raw +
Create a native AWS Lambda handler that passes the raw
HTTP event directly through to lambda-api.
Lambda function handler.
-Initialise all controllers and endpoints declared using decorators.
-Process the passed lambda event and context as a synchronous HTTP request.
+Initialise all controllers and endpoints declared using decorators.
+Process the passed lambda event and context as a synchronous HTTP request.
API Gateway or ALB request.
Request context.
The response.
-AWS Lambda HTTP request event. Used for testing, +
AWS Lambda HTTP request event. Used for testing,
enabling manually passing requests to a ApiLambdaApp
instance.
HTTP request event body, potentially Base64 encoded.
-HTTP request headers as a map.
-HTTP method ('GET', 'POST', 'PUT' etc.)
-Is the body property Base64 encoded?
Request URL path. Excludes protocol, host and port.
-HTTP request query string parameters as a map.
-HTTP request headers as a map.
+HTTP method ('GET', 'POST', 'PUT' etc.)
+Is the body property Base64 encoded?
Request URL path. Excludes protocol, host and port.
+HTTP request query string parameters as a map.
+Response to aAWS Lambda HTTP request event. Used for testing.
-Response to aAWS Lambda HTTP request event. Used for testing.
+HTTP response headers as a map.
+Is the body property Base64 encoded?
HTTP response code (201, 400, 500 etc.)
+Base class for app configuration. Extend this +
Base class for app configuration. Extend this to supply your own configuration properties.
It is recommended to create your own sub-class and register it with the application IOC container.
This class supports all the lambda-api config
options by implementing the Options interface.
OptionalbaseBase path for all routes, e.g. base: 'v1' would prefix all routes with /v1.
-OptionalcallbackOverride the default callback query parameter name +
OptionalcallbackOverride the default callback query parameter name for JSONP calls.
-Optionalloggerlambda-api logging configuration. Enables/disables default logging +
Optionalloggerlambda-api logging configuration. Enables/disables default logging by setting to a boolean value or allows for configuration through a Logging Configuration object.
Defaults to info level logging.
-OptionalmimeName/value pairs of additional MIME types to be supported +
OptionalmimeName/value pairs of additional MIME types to be supported
by the type(). The key should be the file extension
(without the .) and the value should be the expected MIME type,
e.g. application/json.
OptionalnameAPI human readable name.
-OptionalopenOpenAPI configuration.
-OptionalserializerOptional object serializer function. This function receives the +
OptionalnameAPI human readable name.
+OptionalopenOpenAPI configuration.
+OptionalserializerOptional object serializer function. This function receives the body of a response and must return a string. Defaults to JSON.stringify
-OptionalserverLogging configuration for ts-lambda-api. +
OptionalserverLogging configuration for ts-lambda-api. See [[ServerLoggerConfig]] for more information.
Defaults to info level plain string logging.
-OptionalversionVersion number accessible via Request context instances.
OptionalversionVersion number accessible via Request context instances.
Basic authentication details extracted from +
Basic authentication details extracted from a request.
-AbstractIAuthFilter implementation that supports the HTTP Basic authentication scheme.
-AbstractIAuthFilter implementation that supports the HTTP Basic authentication scheme.
+ReadonlyauthenticationString to use in WWW-Authenticate header when returing
a HTTP 401 response, see:
https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml
Abstract ReadonlynameA human readable name for this authentication filter.
-AbstractBase class for API controllers. Provides access to the +
AbstractBase class for API controllers. Provides access to the current HTTP context as protected fields, and convenience method for applying JSON patches.
-Protected_Logger instance for this controller.
-ProtectedrequestThe current HTTP request context.
-ProtectedresponseThe current HTTP response context.
-ProtectedapplyAbstractBase class for implementing error interceptors that are invoked +
AbstractBase class for implementing error interceptors that are invoked to handle errors thrown by endpoints.
-OptionalcontrollerOptionalendpointOptionalcontrollerOptionalendpointAbstractinterceptError interceptors implement this method to handle errors.
Details of error that was thrown by an endpoint, contains the request and response context, which can used to return a custom HTTP response.
Value that you want to send back in the HTTP response; optional.
-Should this interceptor handle a given endpoint error?
+Should this interceptor handle a given endpoint error?
Class name of the controller where the error occurred.
Name of the endpoint; format is ${ClassName}:${MethodName}.
If this is a global error interceptor, denoted by a endpointTarget that equals "*", return true. Otherwise return whether the endpointTarget or controllerTarget match the controller or endpoint respectively.
-Builds implementations of [[ILogger]].
-Builds implementations of [[ILogger]].
+(Optional) Format to output log messages in, defaults to string.
(Optional) Print an ISO 8601 timestamp before every log message?
(string format only, defaults to false).
Create a new logger.
+Create a new logger.
The enclosing class that will use the new logger.
-StaticgetStaticgetCreate a new logger using custom log configuration.
The enclosing class that will use the new logger.
(Optional) Lowest level to log, defaults to info.
(Optional) Format to output log messages in, defaults to string.
(Optional) Print an ISO 8601 timestamp before every log message?
(string format only, defaults to false).
StaticgetCreate a new logger using [[AppConfig]] config defaults.
+StaticgetCreate a new logger using [[AppConfig]] config defaults.
The enclosing class that will use the new logger.
-Holds all the middleware that will be applied to incoming HTTP +
Holds all the middleware that will be applied to incoming HTTP requests before or after calling endpoint methods.
-Authentication filters to apply. These are chained, meaning only one of the filters registered needs to authenticate a user to for the request to be authenticated.
-Authorizers to apply. These are chained, meaning only +
Authorizers to apply. These are chained, meaning only one of the authorizers registered needs to authorise a user against a role for the request to be authorized.
-Error interceptors to use. Multiple interceptors can be +
Error interceptors to use. Multiple interceptors can be registered against one endpoint/controller, however only the first interceptor registered will be invoked.
-Add an authentication filter.
+Add an authentication filter.
The filter to add.
Adds an authorizer.
+Adds an error interceptor.
+Adds an error interceptor.
The interceptor to add.
OptionalenabledSet this flag to true to enable OpenAPI endpoints in your API @ {basePath}/open-api.json and {basePath}/open-api.yml
-OptionaluseSet this flag to apply any registered authentication +
OptionaluseSet this flag to apply any registered authentication filters to OpenAPI spec requests.
-AbstractBase class for security principal returned +
Builds ApiRequest instances using the builder
+
Builds ApiRequest instances using the builder
pattern. Used for testing.
Add a base64 encoded HTTP body to the request.
The body as a base64 string.
This builder instance.
-Add basic authentication to the request.
+Add basic authentication to the request.
Username to send.
Password to send.
This builder instance.
-Add a binary HTTP body to the request.
+Add a binary HTTP body to the request.
The binary body as a Buffer.
This builder instance.
-Add a HTTP body to the request.
+Add a HTTP body to the request.
The body as a raw string.
This builder instance.
-Build a request object using the current builder config.
-Add a HTTP header to the request.
+Build a request object using the current builder config.
+Add a HTTP header to the request.
Name of the header.
Value to set.
This builder instance.
-Add multiple HTTP headers to the request.
+Add multiple HTTP headers to the request.
Map of HTTP headers to add.
This builder instance.
-Add a HTTP query parameter to the request.
+Add a HTTP query parameter to the request.
Name of the query param.
Value to set.
This builder instance.
-Add multiple HTTP query parameters to the request.
+Add multiple HTTP query parameters to the request.
Map of HTTP query params to add.
This builder instance.
-StaticdeleteStart building a HTTP DELETE request.
+StaticdeleteStart building a HTTP DELETE request.
URL path to request.
-StaticdoStart building a HTTP request.
+StaticdoStart building a HTTP request.
HTTP method to use.
URL path to request.
-StaticgetStart building a HTTP GET request.
+StaticgetStart building a HTTP GET request.
URL path to request.
-StaticpatchStart building a HTTP PATCH request.
+StaticpatchStart building a HTTP PATCH request.
URL path to request.
-StaticpostStart building a HTTP POST request.
+StaticpostStart building a HTTP POST request.
URL path to request.
-StaticputStart building a HTTP PUT request.
+StaticputStart building a HTTP PUT request.
URL path to request.
-Server that discovers routes using decorators on controller +
Server that discovers routes using decorators on controller
classes and methods. Processing of requests is preformed by the
lambda-api package.
Configure the API instance from the lambda-api
package.
Function that takes an API instance as a parameter.
Scans the specified path for javascript files and loads these into +
Scans the specified path for javascript files and loads these into the current runtime. Importing the files will invoke the decorators declared within them. Note: this scans only the top level files.
API decorators register controllers, endpoints, configuration and middleware.
@@ -28,9 +28,9 @@
Dynamic loading of injectable controllers is disabled if undefined
or the app Container instance has its autobind
flag disabled.
Takes an API request passed in by AWS Lambda and processes +
Takes an API request passed in by AWS Lambda and processes
it using the lambda-api package.
API Gateway or ALB request.
Request context.
The response.
-Logging configuration for the ts-lambda-api framework.
Logging configuration for the ts-lambda-api framework.
{
"level": "INFO",
"msg": "Endpoint - Invoking endpoint: [GET] /open-api.yml",
"time": 1555865906882 // millis since epoch
}
Lowest level of log message to output.
+Lowest level of log message to output.
See [[LogLevel]] for levels supported.
-OptionallogPrint an ISO 8601 timestamp before every log message? (string format only)
+OptionallogPrint an ISO 8601 timestamp before every log message? (string format only)
Defaults to false, AWS Lambda already includes timestamps in it's log of standard output.
-Optionaloptions: RegisterOptionsOptionaloptions: RegisterOptionsAn Agent object for HTTPS similar to http.Agent. See request for more information.
An Agent object for HTTPS similar to http.Agent. See request for more information.
Like http.Agent, the createConnection(options[, callback]) method can be overridden to customize
how TLS connections are established.
@@ -406,4 +406,4 @@
Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter}
objects.
An Agent is responsible for managing connection persistence
+
An Agent is responsible for managing connection persistence
and reuse for HTTP clients. It maintains a queue of pending requests
for a given host and port, reusing a single socket connection for each
until the queue is empty, at which time the socket is either destroyed
@@ -436,4 +436,4 @@
Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter}
objects.
Optionalctx: ToJSContextA plain JavaScript representation of this node.
Optional__namedParameters: ToJSOptionsA plain JS representation of this node
-Optional_arg: unknownOptionalctx: ToJSContextOptionalctx: StringifyContextOptional_onComment: () => voidOptional_onChompKeep: () => voidOptional_arg: unknownOptionalctx: ToJSContextOptionalctx: StringifyContextOptional_onComment: () => voidOptional_onChompKeep: () => voidDescribes the body of a HTTP request or response.
-Describes the body of a HTTP request or response.
+OptionalclassClass type that the content will store. This will generate a schema in the OpenAPI spec for the given type.
-OptionalcontentContent (MIME) type.
-OptionaldescriptionDescription of this HTTP body.
-OptionalexampleFree form example of this body in plain +
OptionalcontentContent (MIME) type.
+OptionaldescriptionDescription of this HTTP body.
+OptionalexampleFree form example of this body in plain
text. Setting this will prevent type
or class from setting auto-generated
examples.
OptionaltypeType of data the content stores, one of the following:
+OptionaltypeType of data the content stores, one of the following:
array array-array boolean @@ -31,4 +31,4 @@ string string-array
If you specify this value, class is ignored.
Describes the body of a HTTP request or response.
-Describes the body of a HTTP request or response.
+OptionalclassClass type that the content will store. This will generate a schema in the OpenAPI spec for the given type.
-OptionalcontentContent (MIME) type.
-OptionaldescriptionDescription of this HTTP body.
-OptionalexampleFree form example of this body in plain +
OptionalcontentContent (MIME) type.
+OptionaldescriptionDescription of this HTTP body.
+OptionalexampleFree form example of this body in plain
text. Setting this will prevent type
or class from setting auto-generated
examples.
OptionaltypeType of data the content stores, one of the following:
+OptionaltypeType of data the content stores, one of the following:
array array-array boolean @@ -32,5 +32,5 @@ string string-array
If you specify this value, class is ignored.
Describes an API endpoint.
-Describes an API endpoint.
+OptionaldescriptionDescription of the endpoint.
-OptionalnameName of the endpoint.
-OptionalrequestInformation about the endpoint request body.
-OptionalresponsesMap of HTTP status codes (as strings) to response +
OptionalnameName of the endpoint.
+OptionalrequestInformation about the endpoint request body.
+OptionalresponsesMap of HTTP status codes (as strings) to response body info. This means that you can describe the success body of a 200 response as well as the error body of a 500 response.
-Describes an API endpoint.
-Describes an API endpoint.
+OptionaldescriptionDescription of the endpoint.
-OptionalnameName of the endpoint.
-OptionalrequestInformation about the endpoint request body.
-OptionalresponsesMap of HTTP status codes (as strings) to response +
OptionalnameName of the endpoint.
+OptionalrequestInformation about the endpoint request body.
+OptionalresponsesMap of HTTP status codes (as strings) to response body info. This means that you can describe the success body of a 200 response as well as the error body of a 500 response.
-Get the HTTP request info.
-Copy valid properties from another instance responses.
+Get the HTTP request info.
+Copy valid properties from another instance responses.
See [[ApiBodyInfo]]
-Describes a parameter in a HTTP request.
-Describes a parameter in a HTTP request.
+OptionalclassClass type that the content will store. This will generate a schema in the OpenAPI spec for the given type.
-OptionalcontentContent (MIME) type.
-OptionaldescriptionDescription of this HTTP body.
-OptionalexampleFree form example of this body in plain +
OptionalcontentContent (MIME) type.
+OptionaldescriptionDescription of this HTTP body.
+OptionalexampleFree form example of this body in plain
text. Setting this will prevent type
or class from setting auto-generated
examples.
OptionalexplodeSpecifies whether arrays and objects should generate +
OptionalexplodeSpecifies whether arrays and objects should generate separate parameters for each array item or object property; in other words, muiltiple parameters of the same name for array values/object fields (true) or one string per parameter (false); see style field.
-OptionalrequiredIs this parameter required in requests?
-OptionalstyleDefines how array/object is delimited. Possible styles +
OptionalrequiredIs this parameter required in requests?
+OptionalstyleDefines how array/object is delimited. Possible styles depend on the parameter location.
-OptionaltypeType of data the content stores, one of the following:
+OptionaltypeType of data the content stores, one of the following:
array array-array boolean @@ -44,4 +44,4 @@ string string-array
If you specify this value, class is ignored.
The class AsyncResource is designed to be extended by the embedder's async
+
The class AsyncResource is designed to be extended by the embedder's async
resources. Using this, users can easily trigger the lifetime events of their
own resources.
The init hook will trigger when an AsyncResource is instantiated.
A Blob encapsulates immutable, raw data that can be safely shared across
+
A Blob encapsulates immutable, raw data that can be safely shared across
multiple worker threads.
The BlockList object can be used with some network APIs to specify rules for
+
The BlockList object can be used with some network APIs to specify rules for
disabling inbound or outbound access to specific IP addresses, IP ranges, or
IP subnets.
StaticisReturns true if the value is a net.BlockList.
Any JS value
This object is created internally and returned from request. It +
This object is created internally and returned from request. It
represents an in-progress request whose header has already been queued. The
header is still mutable using the setHeader(name, value), getHeader(name), removeHeader(name) API. The actual header will
be sent along with the first data chunk or when calling request.end().
StatictoA utility method for creating a web WritableStream from a Writable.
AbstractAbstractA plain JavaScript representation of this node.
Optional__namedParameters: ToJSOptionsAbstracttoA plain JS representation of this node
-AbstracttoOptionalctx: StringifyContextOptionalonComment: () => voidOptionalonChompKeep: () => voidAbstracttoOptionalctx: StringifyContextOptionalonComment: () => voidOptionalonChompKeep: () => voidOptionaloptions: ContainerOptionsOptionaloptions: GetOptionsOptionaloptions: GetAllOptionsOptionaloptions: GetAllOptionsOptionaloptions: GetOptionsOptionaloptions: IsBoundOptionsOptionaloptions: IsBoundOptionsOptionaloptions: ContainerOptionsOptionaloptions: GetOptionsOptionaloptions: GetAllOptionsOptionaloptions: GetAllOptionsOptionaloptions: GetOptionsOptionaloptions: IsBoundOptionsOptionaloptions: IsBoundOptionsOptionalapiOptionalapiOptionalapiOptionalapiReadonlyclassOptionalconsumesOptionalerrorReadonlynameOptionalnoOptionalpathOptionalproducesOptionalrolesOptionalapiOptionalapiOptionalapiOptionalapiReadonlyclassOptionalconsumesOptionalerrorReadonlynameOptionalnoOptionalpathOptionalproducesOptionalrolesGiven a fully resolved tag, returns its printable string form, taking into account current tag prefixes and defaults.
-Optionaldoc: DocumentOptionaldoc: DocumentOptionaljsonArg: stringUsed by JSON.stringify to indicate the array index or
property name.
OptionalonAnchor: (value: unknown, count: number) => voidOptionaloptions: ToStringOptionsOptionalcontrollerOrMethod: Function | ControllerInfoOptionalmethodName: stringOptionalapiOptionalapiOptionalconsumesOptional ReadonlycontrollerOptionalerrorReadonlymethodOptional ReadonlymethodReadonlynameOptionalnoReadonlyparameterOptionalpathOptionalproducesOptionalrolesOptionalcontrollerOrMethod: Function | ControllerInfoOptionalmethodName: stringOptionalapiOptionalapiOptionalconsumesOptional ReadonlycontrollerOptionalerrorReadonlymethodOptional ReadonlymethodReadonlynameOptionalnoReadonlyparameterOptionalpathOptionalproducesOptionalrolesIntegrates EventEmitter with AsyncResource for EventEmitters that
+
Integrates EventEmitter with AsyncResource for EventEmitters that
require manual async tracking. Specifically, all events emitted by instances
of events.EventEmitterAsyncResource will run within its async context.
import { EventEmitterAsyncResource, EventEmitter } from 'node:events';
import { notStrictEqual, strictEqual } from 'node:assert';
import { executionAsyncId, triggerAsyncId } from 'node:async_hooks';
// Async tracking tooling will identify this as 'Q'.
const ee1 = new EventEmitterAsyncResource({ name: 'Q' });
// 'foo' listeners will run in the EventEmitters async context.
ee1.on('foo', () => {
strictEqual(executionAsyncId(), ee1.asyncId);
strictEqual(triggerAsyncId(), ee1.triggerAsyncId);
});
const ee2 = new EventEmitter();
// 'foo' listeners on ordinary EventEmitters that do not track async
// context, however, run in the same async context as the emit().
ee2.on('foo', () => {
notStrictEqual(executionAsyncId(), ee2.asyncId);
notStrictEqual(triggerAsyncId(), ee2.triggerAsyncId);
});
Promise.resolve().then(() => {
ee1.emit('foo');
ee2.emit('foo');
});
@@ -332,4 +332,4 @@
Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter}
objects.
The EventEmitter class is defined and exposed by the node:events module:
The EventEmitter class is defined and exposed by the node:events module:
import { EventEmitter } from 'node:events';
Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter}
objects.
Optionalinit: HeadersInitReadonly[iterator]ReadonlyappendReadonlydeleteReadonlyentriesReadonlyforReadonlygetReadonlygetReadonlyhasReadonlykeysReadonlysetReadonlyvaluesOptionalinit: HeadersInitReadonly[iterator]ReadonlyappendReadonlydeleteReadonlyentriesReadonlyforReadonlygetReadonlygetReadonlyhasReadonlykeysReadonlysetReadonlyvaluesDo not call instance methods on the input of this function, and do not assume it has the HttpRequest prototype.
-StaticisStaticisAn IncomingMessage object is created by Server or ClientRequest and passed as the first argument to the 'request' and 'response' event respectively. It may be used to
+
An IncomingMessage object is created by Server or ClientRequest and passed as the first argument to the 'request' and 'response' event respectively. It may be used to
access response
status, headers, and data.
Different from its socket value which is a subclass of stream.Duplex, the IncomingMessage itself extends stream.Readable and is created separately to
@@ -835,4 +835,4 @@
StatictoA utility method for creating a web ReadableStream from a Readable.
Optionaloptions: { strategy?: QueuingStrategy<any> }StaticisStaticisTracks newlines during parsing in order to provide an efficient API for +
Tracks newlines during parsing in order to provide an efficient API for
determining the one-indexed { line, col } position for any offset
within the input.
Performs a binary search and returns the 1-indexed { line, col }
position of offset. If line === 0, addNewLine has never been
called or offset is before the first known newline.
AbstractAbstractCreate a copy of this node.
A plain JavaScript representation of this node.
Optional__namedParameters: ToJSOptionsAbstracttoA plain JS representation of this node
-AbstracttoOptionalctx: StringifyContextOptionalonComment: () => voidOptionalonChompKeep: () => voidAbstracttoOptionalctx: StringifyContextOptionalonComment: () => voidOptionalonChompKeep: () => voidOptionaldoc: OpenAPIObjectOptionalreplacer: ReplacerOptionaloptions: StaticcreateOptionaldoc: OpenAPIObjectOptionaldoc: OpenAPIObjectOptionalreplacer: ReplacerOptionaloptions: StaticcreateOptionaldoc: OpenAPIObjectThis class serves as the parent class of ClientRequest and ServerResponse. It is an abstract outgoing message from +
This class serves as the parent class of ClientRequest and ServerResponse. It is an abstract outgoing message from the perspective of the participants of an HTTP transaction.
StatictoA utility method for creating a web WritableStream from a Writable.
Readonly[Always Node or null when parsed, but can be set to anything.
OptionalsrcThe CST token that was composed into this pair.
Always Node or null when parsed, but can be set to anything.
-Optional_: unknownOptionalctx: ToJSContextOptionalctx: StringifyContextOptionalonComment: () => voidOptionalonChompKeep: () => voidOptional_: unknownOptionalctx: ToJSContextOptionalctx: StringifyContextOptionalonComment: () => voidOptionalonChompKeep: () => voidv0.9.4
+StatictoA utility method for creating a web ReadableStream from a Readable.
Optionaloptions: { strategy?: QueuingStrategy<any> }OptionalrawOptionalrawOptionalfileName: stringOptionalage: string | number | booleanOptionalprivate: booleanOptionaloptions: CookieOptionsOptionaloptions: CookieOptionsOptionalfileName: stringOptionaloptions: FileOptionsOptionalcallback: ErrorCallbackOptionaldetail: anyOptionaldetail: anyOptionalenable: booleanOptionalexpires: numberOptionalcallback: ErrorCallbackOptionalvalue: string | string[]Optionalappend: booleanOptionaloptions: FileOptionsOptionalcallback: ErrorCallbackOptionalfileName: stringOptionalage: string | number | booleanOptionalprivate: booleanOptionaloptions: CookieOptionsOptionaloptions: CookieOptionsOptionalfileName: stringOptionaloptions: FileOptionsOptionalcallback: ErrorCallbackOptionaldetail: anyOptionaldetail: anyOptionalenable: booleanOptionalexpires: numberOptionalcallback: ErrorCallbackOptionalvalue: string | string[]Optionalappend: booleanOptionaloptions: FileOptionsOptionalcallback: ErrorCallbackCreate a copy of this node.
A plain JavaScript representation of this node.
Optional__namedParameters: ToJSOptionsA plain JS representation of this node
-Optionalarg: anyOptionalctx: ToJSContextOptionalarg: anyOptionalctx: ToJSContextThis class is an abstraction of a TCP socket or a streaming IPC endpoint
+
This class is an abstraction of a TCP socket or a streaming IPC endpoint
(uses named pipes on Windows, and Unix domain sockets otherwise). It is also
an EventEmitter.
A net.Socket can be created by the user and used directly to interact with
@@ -1128,4 +1128,4 @@
StatictoA utility method for creating a web ReadableStream and WritableStream from a Duplex.
v15.14.0, v14.18.0
+Returns a SocketAddress if parsing was successful.
Otherwise returns undefined.
Duplex streams are streams that implement both the Readable and Writable interfaces.
Duplex streams are streams that implement both the Readable and Writable interfaces.
Examples of Duplex streams include:
TCP socketsStatictoA utility method for creating a web ReadableStream and WritableStream from a Duplex.
The stream.PassThrough class is a trivial implementation of a Transform stream that simply passes the input bytes across to the output. Its purpose is
+
The stream.PassThrough class is a trivial implementation of a Transform stream that simply passes the input bytes across to the output. Its purpose is
primarily for examples and testing, but there are some use cases where stream.PassThrough is useful as a building block for novel sorts of streams.
StatictoA utility method for creating a web ReadableStream and WritableStream from a Duplex.
Transform streams are Duplex streams where the output is in some way
+
Transform streams are Duplex streams where the output is in some way
related to the input. Like all Duplex streams, Transform streams
implement both the Readable and Writable interfaces.
Examples of Transform streams include:
StatictoA utility method for creating a web ReadableStream and WritableStream from a Duplex.
v0.9.4
+StatictoA utility method for creating a web WritableStream from a Writable.
The EventEmitter class is defined and exposed by the node:events module:
The EventEmitter class is defined and exposed by the node:events module:
import { EventEmitter } from 'node:events';
Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter}
objects.
Browser-compatible URL class, implemented by following the WHATWG URL
+
Browser-compatible URL class, implemented by following the WHATWG URL
Standard. Examples of parsed URLs may be found in the Standard itself.
The URL class is also available on the global object.
In accordance with browser conventions, all properties of URL objects
@@ -163,4 +163,4 @@
ID that isn't registered will silently fail.
A 'blob:nodedata:... URL string returned by a prior call to URL.createObjectURL().
The URLSearchParams API provides read and write access to the query of a URL. The URLSearchParams class can also be used standalone with one of the
+
The URLSearchParams API provides read and write access to the query of a URL. The URLSearchParams class can also be used standalone with one of the
four following constructors.
The URLSearchParams class is also available on the global object.
The WHATWG URLSearchParams interface and the querystring module have
@@ -70,4 +70,4 @@
Returns the search parameters serialized as a string, with characters percent-encoded where necessary.
Returns an ES6 Iterator over the values of each name-value pair.
OptionalconstructorOpt: FunctionStaticprepareInstance of Type, Map, or Object
Optionalctx: StringifyContextOptionalonComment: () => voidOptionalonChompKeep: () => voidStaticfromA generic collection parsing method that can be extended to other node classes that inherit from YAMLMap
-A plain JavaScript representation of this node.
Optional__namedParameters: ToJSOptionsA plain JS representation of this node
-Optional_: unknownOptionalctx: ToJSContextOptionalctx: StringifyContextOptionalonComment: () => voidOptionalonChompKeep: () => voidStaticfromOptional_: unknownOptionalctx: ToJSContextOptionalctx: StringifyContextOptionalonComment: () => voidOptionalonChompKeep: () => voidStaticfromOptionalconstructorOpt: FunctionStaticprepareDecorator that can be placed on a method to mark it is an API endpoint +
Decorator that can be placed on a method to mark it is an API endpoint that responds to HTTP DELETE requests.
The URL path that triggers this endpoint; optional if you set a root path on
the class using a apiController decorator. This URL can contain path parameters,
prefixed with a colon (':') character.
Decorator that can be placed on a method to mark it is an API endpoint +
Decorator that can be placed on a method to mark it is an API endpoint that responds to HTTP GET requests.
The URL path that triggers this endpoint; optional if you set a root path on the
class using a apiController decorator. This URL can contain path parameters,
prefixed with a colon (':') character.
Decorator that can be placed on a method to mark it is an API endpoint +
Decorator that can be placed on a method to mark it is an API endpoint that responds to HTTP PATCH requests.
The URL path that triggers this endpoint; optional if you set a root path on
the class using a apiController decorator. This URL can contain path parameters,
prefixed with a colon (':') character.
Decorator that can be placed on a method to mark it is an API endpoint +
Decorator that can be placed on a method to mark it is an API endpoint that responds to HTTP POST requests.
The URL path that triggers this endpoint; optional if you set a root path on
the class using a apiController decorator. This URL can contain path parameters,
prefixed with a colon (':') character.
Decorator that can be placed on a method to mark it is an API endpoint +
Decorator that can be placed on a method to mark it is an API endpoint that responds to HTTP PUT requests.
The URL path that triggers this endpoint; optional if you set a root path on
the class using a apiController decorator. This URL can contain path parameters,
prefixed with a colon (':') character.
A stream to attach a signal to.
+A stream to attach a signal to.
Attaches an AbortSignal to a readable or writeable stream. This lets code
control stream destruction using an AbortController.
Calling abort on the AbortController corresponding to the passed AbortSignal will behave the same way as calling .destroy(new AbortError()) on the
@@ -17,4 +17,4 @@
A signal representing possible cancellation
A stream to attach a signal to.
The utility function duplexPair returns an Array with two items,
+
The utility function duplexPair returns an Array with two items,
each being a Duplex stream connected to the other side:
const [ sideA, sideB ] = duplexPair();
Optionaloptions: DuplexOptionsA value to pass to both Duplex constructors, to set options such as buffering.
Optionaloptions: Stream.FinishedOptionsOptionaloptions: Stream.FinishedOptionsA readable and/or writable stream/webstream.
+A readable and/or writable stream/webstream.
A function to get notified when a stream is no longer readable, writable or has experienced an error or a premature close event.
import { finished } from 'node:stream';
import fs from 'node:fs';
const rs = fs.createReadStream('archive.tar');
finished(rs, (err) => {
if (err) {
console.error('Stream failed.', err);
} else {
console.log('Stream is done reading.');
}
});
rs.resume(); // Drain the stream.
@@ -40,4 +40,4 @@
A callback function that takes an optional error argument.
A cleanup function which removes all registered listeners.
Returns the default highWaterMark used by streams. +
Returns whether the stream has encountered an error.
+Returns whether the stream has encountered an error.
Returns whether the stream is readable.
+Returns whether the stream is readable.
Only returns null if stream is not a valid Readable, Duplex or ReadableStream.
Returns whether the stream is writable.
+Returns whether the stream is writable.
Only returns null if stream is not a valid Writable, Duplex or WritableStream.
Optionaloptions: FinishedOptionsOptionaloptions: FinishedOptionsOptionaloptions: PipelineOptionsOptionaloptions: PipelineOptionsOptionaloptions: PipelineOptionsOptionaloptions: PipelineOptionsOptionaloptions: PipelineOptionsOptionaloptions: PipelineOptionsOptionaloptions: PipelineOptionsOptionaloptions: PipelineOptionsOptionaloptions: PipelineOptionsOptionaloptions: PipelineOptionsOptionaloptions: PipelineOptionsOptionaloptions: PipelineOptionsOptionaloptions: PipelineOptionsOptionaloptions: PipelineOptionsOptionaloptions: PipelineOptionsOptionaloptions: PipelineOptionsA module method to pipe between streams and generators forwarding errors and +
A module method to pipe between streams and generators forwarding errors and properly cleaning up and provide a callback when the pipeline is complete.
import { pipeline } from 'node:stream';
import fs from 'node:fs';
import zlib from 'node:zlib';
// Use the pipeline API to easily pipe a series of streams
// together and get notified when the pipeline is fully done.
// A pipeline to gzip a potentially huge tar file efficiently:
pipeline(
fs.createReadStream('archive.tar'),
zlib.createGzip(),
fs.createWriteStream('archive.tar.gz'),
(err) => {
if (err) {
console.error('Pipeline failed.', err);
} else {
console.log('Pipeline succeeded.');
}
},
);
Sets the default highWaterMark used by streams.
+Decorator for a controller class to describe it in any generated +
Decorator for a controller class to describe it in any generated OpenAPI specification.
Name of the API used to categorise endpoints in this controller.
-Optionaldescription: stringOptionaldescription: stringDecorator that can be placed on a class to mark it is an API controller.
+Decorator that can be placed on a class to mark it is an API controller.
Optionalpath: stringA root URL path that all endpoints in this controller share; optional. This URL can contain path parameters, prefixed with a colon (':') character.
-Decorator that can be placed on an endpoint method to exclude it from any generated +
Decorator for a controller class to exclude it from any generated +
Decorator that can be placed on an endpoint to describe it in any generated +
Decorator that can be placed on an endpoint to describe it in any generated OpenAPI specification.
Information about this api operation; will be merged with existing info if present, replacing any existing properties, if provided in this parameter.
-Decorator that can be placed on an endpoint to describe the request +
Decorator that can be placed on an endpoint to describe the request in any generated OpenAPI specification.
Request body info.
-Decorator that can be placed on an endpoint to describe a possible response +
Decorator that can be placed on an endpoint to describe a possible response in any generated OpenAPI specification.
HTTP status code that will be sent in this response.
OptionalapiBodyInfo: ApiBodyInformation about the response body generated.
-Decorator for a auth filter implementation to describe it in any generated +
Decorator for a auth filter implementation to describe it in any generated OpenAPI specification as a security scheme.
Name of the API security scheme.
openapi3-ts security scheme model.
Decorator which injects the HTTP request body as a parameter value.
+Decorator which injects the HTTP request body as a parameter value.
Value passed to the method will be an object, array or primitive value if the request body is JSON, otherwise it will be a string.
-Decorator for an endpoint method that details the HTTP request Content-Type header value.
+Decorator for an endpoint method that details the HTTP request Content-Type header value.
Overrides the controller value set by the controllerConsumes decorator, if any.
OptionalcontentType: stringRequest content type.
-OptionalapiBodyInfo: ApiBodyOptionalapiBodyInfo: ApiBodyDecorator for a controller class that details the HTTP request Content-Type header value for +
Decorator for a controller class that details the HTTP request Content-Type header value for all endpoints.
Request content type.
-OptionalapiBodyInfo: ApiBodyOptionalapiBodyInfo: ApiBodyDecorator for a controller class that configures the type to use to intercept errors.
+Decorator for a controller class that configures the type to use to intercept errors.
Error interceptors instances are built using the current app InversifyJS IOC container.
-Decorator for a controller class that sets the HTTP response Content-Type header value for +
Decorator for a controller class that sets the HTTP response Content-Type header value for all endpoints.
Content-Type header value.
-Decorator for a controller class that defines roles that are allowed to user all +
Decorator for a controller class that defines roles that are allowed to user all endpoints within it.
Role based authorization is managed by a IAuthorizer implementation registered
with the current app.
Names of roles that are permitted to use the endpoints in this controller.
-Decorator for an endpoint method that configures the type to use to intercept errors.
+Decorator for an endpoint method that configures the type to use to intercept errors.
Overrides the controller error interceptor set by the controllerErrorInterceptor decorator, if any.
Error interceptors instances are built using the InversifyJS IOC container for the current app.
-Decorator which injects a HTTP request header as a parameter value.
+Decorator which injects a HTTP request header as a parameter value.
Value passed to the method will be a string.
The name of the header to inject.
-OptionalapiParamInfo: ApiParamOptionalapiParamInfo: ApiParamDecorator which injects a path parameter value as an endpoint parameter value.
+Decorator which injects a path parameter value as an endpoint parameter value.
Value passed to the method will be a string.
The name of the path parameter to inject.
OptionalapiParamInfo: ApiParam(Optional) OpenApi metadata about the path parameter.
-Decorator which injects the current authentication principal as a parameter value.
+Decorator which injects the current authentication principal as a parameter value.
Value passed to the method will be an implementation of the Principal interface.
Decorator for an endpoint method that sets the HTTP response Content-Type header value.
+Decorator for an endpoint method that sets the HTTP response Content-Type header value.
Overrides the controller value set by the controllerProduces decorator, if any.
Content-Type header value.
-Decorator which injects a query parameter value as an endpoint parameter value.
+Decorator which injects a query parameter value as an endpoint parameter value.
Value passed to the method will be a string.
The name of the query parameter to inject.
-OptionalapiParamInfo: ApiParamOptionalapiParamInfo: ApiParamDecorator which injects the raw HTTP request body as a parameter value.
+Decorator which injects the raw HTTP request body as a parameter value.
Value passed to the method will be a Buffer.
-Decorator which injects a the current HTTP request context as a parameter value.
+Decorator which injects a the current HTTP request context as a parameter value.
Value passed to the method will be of type Request from the lambda-api package.
Decorator which injects a the current HTTP response context as a parameter value.
+Decorator which injects a the current HTTP response context as a parameter value.
Value passed to the method will be of type Response from the lambda-api package.
Decorator for an endpoint method that defines roles that are allowed to use it.
+Decorator for an endpoint method that defines roles that are allowed to use it.
Overrides the controller roles set by the controllerRolesAllowed decorator, if any.
Role based authorization is managed by an IAuthorizer implementation registered
with the current app.
Names of roles that are permitted to use the endpoint.
-Decorator that can be applied to a method or function to +
Decorator that can be applied to a method or function to profile it's execution time in milliseconds. Timing info is output to the console.
The environment variable PROFILE_API must be set to 1 for
profiling information to be recorded and output.
Build REST API's using Typescript & AWS Lambda.
@@ -682,4 +682,4 @@Developing this package on your own machine requires a Unix shell, as the build scripts use Bash and Unix shell commands.
For Windows machines please work under Git Bash or WSL.
-Authentication filter that can extract authentication data +
Authentication filter that can extract authentication data from a HTTP request and preform authentication using that data.
Authentication data type
Principal data type, the type must extend Principal
ReadonlyauthenticationString to use in WWW-Authenticate header when returing
a HTTP 401 response, see:
https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml
ReadonlynameA human readable name for this authentication filter.
-Attempt to authorise a user suing the authentication data supplied. +
ReadonlynameA human readable name for this authentication filter.
+Attempt to authorise a user suing the authentication data supplied.
An instance of the principal type U should be returned on authentication
success, otherwise undefined should be returned.
An instance of the authentication data type T.
Instance of type U or undefined on authentication failure.
Authorizer to perform role based checks for a principal.
+Authorizer to perform role based checks for a principal.
Check that a principal has a named role.
+Check that a principal has a named role.
The current principal context.
The name of the role to check for.
true if the principal is authorised to use the name role, otherwise false.
Describes a generic logging implementation.
-Describes a generic logging implementation.
+Log a debug level message.
+ReadonlylevelSee [[ServerLoggerConfig]]
+Log a debug level message.
String which can contain sprintf style format placeholders.
(Optional) Arguments which are passed to sprintf to format the message.
Is debug log level enabled?
-Log a error level message.
+Is debug log level enabled?
+Log a error level message.
String which can contain sprintf style format placeholders.
(Optional) Arguments which are passed to sprintf to format the message.
Is error log level enabled?
-Log a error level message with an associated error and stack trace.
+Is error log level enabled?
+Log a error level message with an associated error and stack trace.
String which can contain sprintf style format placeholders.
Error object associated with this error message.
(Optional) Arguments which are passed to sprintf to format the message.
Log a fatal level message.
+Log a fatal level message.
String which can contain sprintf style format placeholders.
(Optional) Arguments which are passed to sprintf to format the message.
Is fatal log level enabled?
-Log a info level message.
+Is fatal log level enabled?
+Log a info level message.
String which can contain sprintf style format placeholders.
(Optional) Arguments which are passed to sprintf to format the message.
Is info log level enabled?
-Is the current log level off?
Is a given log level enabled?
+Is info log level enabled?
+Is the current log level off?
Log a message with a custom level.
+Log a message with a custom level.
Level of the log message.
String which can contain sprintf style format placeholders.
(Optional) Arguments which are passed to sprintf to format the message.
Log a trace level message.
+Log a trace level message.
String which can contain sprintf style format placeholders.
(Optional) Arguments which are passed to sprintf to format the message.
Is trace log level enabled?
-Log a warn trace level message.
+Is trace log level enabled?
+Log a warn trace level message.
String which can contain sprintf style format placeholders.
(Optional) Arguments which are passed to sprintf to format the message.
Is warn log level enabled?
-Is warn log level enabled?
+OptionalvpceOptionalvpcOptionalvpceOptionalvpcWorks with HTTP API integration Payload Format version 2.0
+Works with HTTP API integration Payload Format version 2.0
OptionalauthenticationOptionalauthenticationOptionalconnectedOptionalconnectionOptionaldomainOptionaldomainOptionaleventOptionalextendedOptionalmessageOptionalmessageOptionalrequestOptionalrouteOptionalconnectedOptionalconnectionOptionaldomainOptionaldomainOptionaleventOptionalextendedOptionalmessageOptionalmessageOptionalrequestOptionalrouteProxy Event with adaptable requestContext for different authorizer scenarios
+Proxy Event with adaptable requestContext for different authorizer scenarios
OptionalbodyOptionalcookiesOptionalpathOptionalqueryOptionalstageOptionalbodyOptionalcookiesOptionalpathOptionalqueryOptionalstageuse platform (global) type for AbortSignal.
+use platform (global) type for AbortSignal.
Holders of an AbortSignal object may query if the associated operation has been aborted and register an onabort handler.
https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
@@ -7,4 +7,4 @@Optionaloptions: boolean | AddEventListenerOptionsOptionaloptions: boolean | EventListenerOptionsOptionaloptions: boolean | AddEventListenerOptionsOptionaloptions: boolean | EventListenerOptionsOptionaloptions: boolean | AddEventListenerOptionsOptionaloptions: boolean | EventListenerOptionsOptionaloptions: boolean | AddEventListenerOptionsOptionaloptions: boolean | EventListenerOptionsOptionalsocketOptionalticket48-bytes of cryptographically strong pseudo-random data. See Session Resumption for more information.
OptionaltimeoutSocket timeout in milliseconds. This will set the timeout after the socket is connected.
-OptionalschedulingScheduling strategy to apply when picking the next free socket to use.
OptionaltimeoutSocket timeout in milliseconds. This will set the timeout after the socket is connected.
-OptionalreturnOptionalvalue: anyOptionalthrowOptionale: anyOptionalreturnOptionalvalue: anyOptionalthrowOptionale: anyCreates a new AsyncGenerator object.
+Creates a new AsyncGenerator object.
A list of arguments the function accepts.
Describes a user-defined AsyncIterator that is also async iterable.
+Describes a user-defined AsyncIterator that is also async iterable.
OptionalreturnOptionalvalue: TReturn | PromiseLike<TReturn>OptionalthrowOptionale: anyOptionalreturnOptionalvalue: TReturn | PromiseLike<TReturn>OptionalthrowOptionale: anyOptionalreturnOptionalvalue: TReturn | PromiseLike<TReturn>OptionalthrowOptionale: anyOptionalreturnOptionalvalue: TReturn | PromiseLike<TReturn>OptionalthrowOptionale: anyInternalAuthentication schemes represent a way that the service will authenticate the customer’s identity.
+InternalAuthentication schemes represent a way that the service will authenticate the customer’s identity.
OptionalsigningInternalOptionalallowOptionalallowOptionalcontentOptionaldeprecatedOptionaldescriptionOptionalexampleOptionalexamplesOptionalexplodeOptionalrequiredOptionalschemaOptionalstyleOptionalallowOptionalallowOptionalcontentOptionaldeprecatedOptionaldescriptionOptionalexampleOptionalexamplesOptionalexplodeOptionalrequiredOptionalschemaOptionalstyleExperimentalExperimentalOptional ExperimentalendingsOne of either 'transparent' or 'native'. When set to 'native', line endings in string source parts
will be converted to the platform native line-ending as specified by import { EOL } from 'node:os'.
Optional ExperimentaltypeThe Blob content-type. The intent is for type to convey
the MIME media type of the data, however no validation of the type format
is performed.
A function that, given a request body, determines the +
A function that, given a request body, determines the length of the body. This is used to determine the Content-Length that should be sent with a request.
An object that provides a checksum of data provided in chunks to update.
+
An object that provides a checksum of data provided in chunks to update.
The checksum may be performed incrementally as chunks are received or all
at once when the checksum is finalized, depending on the underlying
implementation.
Implementations may override this method which passes second param which makes Checksum object stateless.
The buffer to update checksum with.
-InternalInternalInternalInternalA constructor for a Checksum that may be used to calculate an HMAC. Implementing +
A constructor for a Checksum that may be used to calculate an HMAC. Implementing classes should not directly hold the provided key in memory beyond the lexical scope of the constructor.
Optionalsecret: SourceDataOptionalsecret: SourceDataOptionalclientOptionaldisableOptionaldisableOptionalendpointOptionalforceOptionalregionOptionaluseOptionaluseOptionaluseOptionaluseOptionaluseOptionalclientOptionaldisableOptionaldisableOptionalendpointOptionalforceOptionalregionOptionaluseOptionaluseOptionaluseOptionaluseOptionaluseInternalA client protocol defines how to convert a message (e.g. HTTP request/response) to and from a data object.
+InternalA client protocol defines how to convert a message (e.g. HTTP request/response) to and from a data object.
the payload codec if the requests/responses have a symmetric format. It otherwise may return null.
the Smithy qualified shape id.
-use $ClientProtocolCtor.
+From T, pick a set of properties whose keys are in the union K
+From T, pick a set of properties whose keys are in the union K
OptionalhostOptionalhostnameOptionalinsecureOptionaljoinOptionallocalOptionallocalOptionallookupOptionalmaxOptionalmethodOptionalpathOptionalportOptionalprotocolOptionalsetOptionalsetOptionalsignalOptionalsocketOptionaltimeoutOptionaluniqueOptionalmethodOptionalpathOptionalportOptionalprotocolOptionalsetOptionalsetOptionalsignalOptionalsocketOptionaltimeoutOptionaluniqueInternalA codec creates serializers and deserializers for some format such as JSON, XML, or CBOR.
+InternalA codec creates serializers and deserializers for some format such as JSON, XML, or CBOR.
OptionaltestAllows a protocol, codec, or serde utility to accept the serdeContext +
Allows a protocol, codec, or serde utility to accept the serdeContext from a client configuration or request/response handlerExecutionContext.
OptionalsocketOptionalticket48-bytes of cryptographically strong pseudo-random data. See Session Resumption for more information.
-OptionaltimeoutOptionaltimeoutHandler context parameter. +
Handler context parameter. See AWS documentation.
A function that, given a string, can derive the bytes represented by that +
A function that, given a string, can derive the bytes represented by that string.
InternalDefault extension configuration consisting various configurations for modifying a service client
+InternalDefault extension configuration consisting various configurations for modifying a service client
Get retry strategy used for all http requests
Set retry strategy used for all http requests
-OptionaloutputThe raw response object from runtime is deserialized to structured output object. The response object is unknown so you cannot modify it directly. When work with response, you need to guard its type to e.g. HttpResponse with 'instanceof' operand.
During the deserialize phase of the execution of a middleware stack, a deserialized response may or may not be available
-The typing of directives fails in TS <= 4.2
+OptionaljsonArg: stringUsed by JSON.stringify to indicate the array index or
property name.
OptionalonAnchor: (value: unknown, count: number) => voidOptionaloptions: ToStringOptionsA function that, given a Uint8Array of bytes, can produce a string +
A function that, given a Uint8Array of bytes, can produce a string representation thereof. The function may optionally attempt to convert other input types to Uint8Array before encoding.
An encoder function that converts bytes to hexadecimal
representation would return `'hello'` when given
`new Uint8Array([104, 101, 108, 108, 111])`.
@@ -8,4 +8,4 @@
Runtime support is limited to Uint8Array and string by default.
You may choose to support more encoder input types if overriding the default
implementations.
-use EndpointV2 from @smithy/types.
use EndpointV2 from @smithy/types.
Endpoint config interfaces and resolver for Endpoint v2. They live in separate package to allow per-service onboarding. +
Endpoint config interfaces and resolver for Endpoint v2. They live in separate package to allow per-service onboarding. When all services onboard Endpoint v2, the resolver in config-resolver package can be removed. This interface includes all the endpoint parameters with built-in bindings of "AWS::" and "SDK::"
OptionaltlsWhether TLS is enabled for requests.
OptionaluseEnables IPv6/IPv4 dualstack endpoint.
OptionaluseEnables FIPS compatible endpoints.
-InternalInternalOptionalAccelerateOptionalBucketOptionalCopyOptionalDisableOptionalDisableOptionalDisableOptionalEndpointOptionalForceOptionalKeyOptionalPrefixOptionalRegionOptionalUseOptionalUseOptionalUseOptionalUseOptionalUseOptionalUseOptionalAccelerateOptionalBucketOptionalCopyOptionalDisableOptionalDisableOptionalDisableOptionalEndpointOptionalForceOptionalKeyOptionalPrefixOptionalRegionOptionalUseOptionalUseOptionalUseOptionalUseOptionalUseOptionalUseReadonlybubblesReadonlycancelableReadonlycomposedReadonlycurrentReadonlydefaultReadonlyeventReadonlyisReadonlysrcReadonlytargetReadonlytimeReadonlytypeOptionalbubbles: booleanOptionalcancelable: booleanReadonlybubblesReadonlycancelableReadonlycomposedReadonlycurrentReadonlydefaultReadonlyeventReadonlyisReadonlysrcReadonlytargetReadonlytimeReadonlytypeOptionalbubbles: booleanOptionalcancelable: booleanReadonlybubblesReadonlycancelableReadonlycomposedReadonlycurrentReadonlydefaultReadonlyeventReadonlyisReadonlysrcReadonlytargetReadonlytimeReadonlytypeOptionalbubbles: booleanOptionalcancelable: booleanReadonlybubblesReadonlycancelableReadonlycomposedReadonlycurrentReadonlydefaultReadonlyeventReadonlyisReadonlysrcReadonlytargetReadonlytimeReadonlytypeOptionalbubbles: booleanOptionalcancelable: booleanThe class AsyncResource is designed to be extended by the embedder's async
+
The class AsyncResource is designed to be extended by the embedder's async
resources. Using this, users can easily trigger the lifetime events of their
own resources.
The init hook will trigger when an AsyncResource is instantiated.
Optional arguments to pass to the function.
The same triggerAsyncId that is passed to the AsyncResource constructor.
The NodeEventTarget is a Node.js-specific extension to EventTarget
+
The NodeEventTarget is a Node.js-specific extension to EventTarget
that emulates a subset of the EventEmitter API.
EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.
Returns a reference to the EventEmitter, so that calls can be chained.
An interface which provides functions for serializing and deserializing binary event stream +
An interface which provides functions for serializing and deserializing binary event stream to/from corresponsing modeled shape.
A function which deserializes binary event stream message into modeled shape.
-A function which deserializes binary event stream message into modeled shape.
+A function that serializes modeled shape into binary stream message.
-A function that serializes modeled shape into binary stream message.
+Optionaloptions: boolean | AddEventListenerOptionsOptionaloptions: boolean | EventListenerOptionsOptionaloptions: boolean | AddEventListenerOptionsOptionaloptions: boolean | EventListenerOptionsOptionaloptions: boolean | AddEventListenerOptionsOptionaloptions: boolean | EventListenerOptionsOptionaloptions: boolean | AddEventListenerOptionsOptionaloptions: boolean | EventListenerOptionsRepresents the http options that can be passed to a browser http client.
+Represents the http options that can be passed to a browser http client.
OptionalrequestThe number of milliseconds a request can take before being automatically terminated.
-Asynchronously converts an input object into an output object.
+Asynchronously converts an input object into an output object.
An object containing a input to the command as well as any associated or previously generated execution artifacts.
-The raw response object from runtime is deserialized to structured output object. The response object is unknown so you cannot modify it directly. When work with response, you need to guard its type to e.g. HttpResponse with 'instanceof' operand.
During the deserialize phase of the execution of a middleware stack, a deserialized response may or may not be available
-OptionalresponseDetermines when checksum validation will be performed on response payloads.
-A typed array of 16-bit float values. The contents are initialized to 0. If the requested number +
A typed array of 16-bit float values. The contents are initialized to 0. If the requested number of bytes could not be allocated an exception is raised.
The value to insert into the copied array.
A copy of the original array with the inserted value.
-OptionalthisArg: anyValue of 'this' used to invoke the mapfn.
Returns a new array from a set of elements.
A set of elements to include in the new array object.
-A function that returns Readable Stream which follows aws-chunked encoding stream. +
A function that returns Readable Stream which follows aws-chunked encoding stream. It optionally adds checksum if options are provided.
-An object that provides a hash of data provided in chunks to update. The
+
An object that provides a hash of data provided in chunks to update. The
hash may be performed incrementally as chunks are received or all at once
when the hash is finalized, depending on the underlying implementation.
use Checksum
@@ -11,4 +11,4 @@ encoding, implementations must assume UTF-8 encoding.Not all encodings are supported on all platforms, though all must support UTF-8.
-Optionalencoding: "utf8" | "ascii" | "latin1"Optionalencoding: "utf8" | "ascii" | "latin1"A constructor for a hash that may be used to calculate an HMAC. Implementing +
A constructor for a hash that may be used to calculate an HMAC. Implementing classes should not directly hold the provided key in memory beyond the lexical scope of the constructor.
Optionalsecret: SourceDataOptionalsecret: SourceDataOptional$refOptionalallowOptionalallowOptionalcontentOptionaldeprecatedOptionaldescriptionOptionalexampleOptionalexamplesOptionalexplodeOptionalrequiredOptionalschemaOptionalstyleOptional$refOptionalallowOptionalallowOptionalcontentOptionaldeprecatedOptionaldescriptionOptionalexampleOptionalexamplesOptionalexplodeOptionalrequiredOptionalschemaOptionalstyleReadonly[iterator]ReadonlyappendReadonlydeleteReadonlyentriesReadonlyforReadonlygetReadonlygetReadonlyhasReadonlykeysReadonlysetReadonlyvaluesReadonly[iterator]ReadonlyappendReadonlydeleteReadonlyentriesReadonlyforReadonlygetReadonlygetReadonlyhasReadonlykeysReadonlysetReadonlyvaluesInternalInternalInternalInterface that defines the identity and signing properties when selecting +
InternalInterface that defines the identity and signing properties when selecting an HttpAuthScheme.
InternalInterface that defines an HttpAuthScheme
+InternalInterface that defines an HttpAuthScheme
ID for an HttpAuthScheme, typically the absolute shape ID of a Smithy auth trait.
HttpSigner corresponding to an HttpAuthScheme.
Gets the IdentityProvider corresponding to an HttpAuthScheme.
-OptionalsystemAn offset value in milliseconds to apply to all signing times.
-InternalInternalInternalInternalInternalInternalRepresents the options that may be passed to an Http Handler.
+Represents the options that may be passed to an Http Handler.
Represents an HTTP message with headers and an optional static or streaming +
Represents an HTTP message with headers and an optional static or streaming body. body: ArrayBuffer | ArrayBufferView | string | Uint8Array | Readable | ReadableStream;
Interface an HTTP request class. Contains +
Interface an HTTP request class. Contains addressing information in addition to standard message properties.
Represents an HTTP message as received in reply to a request. Contains a +
Represents an HTTP message as received in reply to a request. Contains a numeric status code in addition to standard message properties.
InternalInterface to sign identity and signing properties.
+InternalInterface to sign identity and signing properties.
identity to sing the request with
property bag for signing
signed request in a promise
-InternalInterface to get an IdentityProvider for a specified HttpAuthScheme
+InternalInterface to get an IdentityProvider for a specified HttpAuthScheme
Get the IdentityProvider for a specified HttpAuthScheme.
schemeId of the HttpAuthScheme
IdentityProvider or undefined if HttpAuthScheme is not found
-OptionalacceptOptionalaccept-Optionalaccept-Optionalaccept-Optionalaccept-Optionalaccess-Optionalaccess-Optionalaccess-Optionalaccess-Optionalaccess-Optionalaccess-Optionalaccess-Optionalaccess-OptionalageOptionalallowOptionalalt-OptionalauthorizationOptionalcache-OptionalconnectionOptionalcontent-Optionalcontent-Optionalcontent-Optionalcontent-Optionalcontent-Optionalcontent-Optionalcontent-OptionalcookieOptionaldateOptionaletagOptionalexpectOptionalexpiresOptionalforwardedOptionalfromOptionalhostOptionalif-Optionalif-Optionalif-Optionalif-Optionallast-OptionallocationOptionaloriginOptionalpragmaOptionalproxy-Optionalproxy-Optionalpublic-OptionalrangeOptionalrefererOptionalretry-Optionalsec-Optionalsec-Optionalsec-Optionalsec-Optionalsec-Optionalsec-Optionalsec-Optionalsec-Optionalsec-Optionalset-Optionalstrict-OptionaltkOptionaltrailerOptionaltransfer-OptionalupgradeOptionaluser-OptionalvaryOptionalviaOptionalwarningOptionalwww-OptionalacceptOptionalaccept-Optionalaccept-Optionalaccept-Optionalaccept-Optionalaccess-Optionalaccess-Optionalaccess-Optionalaccess-Optionalaccess-Optionalaccess-Optionalaccess-Optionalaccess-OptionalageOptionalallowOptionalalt-OptionalauthorizationOptionalcache-OptionalconnectionOptionalcontent-Optionalcontent-Optionalcontent-Optionalcontent-Optionalcontent-Optionalcontent-Optionalcontent-OptionalcookieOptionaldateOptionaletagOptionalexpectOptionalexpiresOptionalforwardedOptionalfromOptionalhostOptionalif-Optionalif-Optionalif-Optionalif-Optionallast-OptionallocationOptionaloriginOptionalpragmaOptionalproxy-Optionalproxy-Optionalpublic-OptionalrangeOptionalrefererOptionalretry-Optionalsec-Optionalsec-Optionalsec-Optionalsec-Optionalsec-Optionalsec-Optionalsec-Optionalsec-Optionalsec-Optionalset-Optionalstrict-OptionaltkOptionaltrailerOptionaltransfer-OptionalupgradeOptionaluser-OptionalvaryOptionalviaOptionalwarningOptionalwww-The raw response object from runtime is deserialized to structured output object. The response object is unknown so you cannot modify it directly. When work with response, you need to guard its type to e.g. HttpResponse with 'instanceof' operand.
During the deserialize phase of the execution of a middleware stack, a deserialized response may or may not be available
-OptionalreturnOptionalvalue: TReturnOptionalthrowOptionale: anyOptionalreturnOptionalvalue: TReturnOptionalthrowOptionale: anyInternalSchema for the list aggregate type.
+InternalSchema for the list aggregate type.
Represents a logger object that is available in HandlerExecutionContext +
Represents a logger object that is available in HandlerExecutionContext throughout the middleware stack.
OptionalaccessOptionalcustomOptionaldetailOptionalerrorOptionallevelOptionallevelsOptionalmessageOptionalnestedOptionalsamplingOptionalserializersOptionalstackOptionaltimestampOptionalaccessOptionalcustomOptionaldetailOptionalerrorOptionallevelOptionallevelsOptionalmessageOptionalnestedOptionalsamplingOptionalserializersOptionalstackOptionaltimestampInternalSchema for the map aggregate type.
+InternalSchema for the map aggregate type.
An event stream message. The headers and body properties will always be +
Represents the http options that can be passed to a node http client.
+Represents the http options that can be passed to a node http client.
OptionalthrowBecause requestTimeout was for a long time incorrectly being set as a socket idle timeout, users must also opt-in for request timeout thrown errors. Without this setting, a breach of the request timeout will be logged as a warning.
-Normalization wrapper for various schema data objects.
+Normalization wrapper for various schema data objects.
For list/set/map.
-Returns a date converted to a string using the current locale.
Returns a string representation of an object.
Returns the primitive value of the specified object.
-This function is called for every chunk of incoming data.
Two arguments are passed to it: the number of bytes written to buffer and a reference to buffer.
Return false from this function to implicitly pause() the socket.
OptionalcallbacksOptionaldeprecatedOptionaldescriptionOptionalexternalOptionaloperationOptionalparametersOptionalrequestOptionalresponsesOptionalsecurityOptionalserversOptionalsummaryOptionaltagsOptionalcallbacksOptionaldeprecatedOptionaldescriptionOptionalexternalOptionaloperationOptionalparametersOptionalrequestOptionalresponsesOptionalsecurityOptionalserversOptionalsummaryOptionaltagsInternalSchema for an operation.
+OptionalbaseOptionalcallbackOptionalcompressionOptionalerrorOptionalheadersOptionalisOptionalloggerOptionalmimeOptionals3OptionalserializerOptionalversionOptionalbaseOptionalcallbackOptionalcompressionOptionalerrorOptionalheadersOptionalisOptionalloggerOptionalmimeOptionals3OptionalserializerOptionalversionOptionalacceptOptionalaccept-Optionalaccept-Optionalaccept-Optionalaccept-Optionalaccess-Optionalaccess-Optionalaccess-Optionalaccess-Optionalaccess-Optionalaccess-Optionalaccess-Optionalaccess-OptionalageOptionalallowOptionalauthorizationOptionalcache-Optionalcdn-OptionalconnectionOptionalcontent-Optionalcontent-Optionalcontent-Optionalcontent-Optionalcontent-Optionalcontent-Optionalcontent-Optionalcontent-Optionalcontent-OptionalcookieOptionaldateOptionaldavOptionaldntOptionaletagOptionalexpectOptionalexpiresOptionalforwardedOptionalfromOptionalhostOptionalif-Optionalif-Optionalif-Optionalif-Optionalif-Optionallast-OptionallinkOptionallocationOptionalmax-OptionaloriginOptionalpragmaOptionalproxy-Optionalproxy-Optionalpublic-Optionalpublic-OptionalrangeOptionalrefererOptionalreferrer-OptionalrefreshOptionalretry-Optionalsec-Optionalsec-Optionalsec-Optionalsec-Optionalsec-OptionalserverOptionalset-Optionalstrict-OptionalteOptionaltrailerOptionaltransfer-OptionalupgradeOptionalupgrade-Optionaluser-OptionalvaryOptionalviaOptionalwarningOptionalwww-Optionalx-Optionalx-Optionalx-Optionalx-OptionalacceptOptionalaccept-Optionalaccept-Optionalaccept-Optionalaccept-Optionalaccess-Optionalaccess-Optionalaccess-Optionalaccess-Optionalaccess-Optionalaccess-Optionalaccess-Optionalaccess-OptionalageOptionalallowOptionalauthorizationOptionalcache-Optionalcdn-OptionalconnectionOptionalcontent-Optionalcontent-Optionalcontent-Optionalcontent-Optionalcontent-Optionalcontent-Optionalcontent-Optionalcontent-Optionalcontent-OptionalcookieOptionaldateOptionaldavOptionaldntOptionaletagOptionalexpectOptionalexpiresOptionalforwardedOptionalfromOptionalhostOptionalif-Optionalif-Optionalif-Optionalif-Optionalif-Optionallast-OptionallinkOptionallocationOptionalmax-OptionaloriginOptionalpragmaOptionalproxy-Optionalproxy-Optionalpublic-Optionalpublic-OptionalrangeOptionalrefererOptionalreferrer-OptionalrefreshOptionalretry-Optionalsec-Optionalsec-Optionalsec-Optionalsec-Optionalsec-OptionalserverOptionalset-Optionalstrict-OptionalteOptionaltrailerOptionaltransfer-OptionalupgradeOptionalupgrade-Optionaluser-OptionalvaryOptionalviaOptionalwarningOptionalwww-Optionalx-Optionalx-Optionalx-Optionalx-OptionalallowOptionalallowOptionalcontentOptionaldeprecatedOptionaldescriptionOptionalexampleOptionalexamplesOptionalexplodeOptionalrequiredOptionalschemaOptionalstyleOptionalallowOptionalallowOptionalcontentOptionaldeprecatedOptionaldescriptionOptionalexampleOptionalexamplesOptionalexplodeOptionalrequiredOptionalschemaOptionalstyleCreate a copy of this node.
A plain JavaScript representation of this node.
Optional__namedParameters: ToJSOptionsA plain JS representation of this node
-Optionalarg: anyOptionalctx: ToJSContextOptionalarg: anyOptionalctx: ToJSContextOptional__namedParameters: ToJSOptionsOptional_: unknownOptionalctx: ToJSContextConversion context, originally set in Document#toJS()
OptionalType: new () => TIf set, forces the returned collection type
Instance of Type, Map, or Object
-Optionalctx: StringifyContextOptionalonComment: () => voidOptionalonChompKeep: () => voidOptionalctx: StringifyContextOptionalonComment: () => voidOptionalonChompKeep: () => voidA plain JavaScript representation of this node.
Optional__namedParameters: ToJSOptionsA plain JS representation of this node
-Optional_: unknownOptionalctx: ToJSContextOptionalctx: StringifyContextOptionalonComment: () => voidOptionalonChompKeep: () => voidOptional_: unknownOptionalctx: ToJSContextOptionalctx: StringifyContextOptionalonComment: () => voidOptionalonChompKeep: () => voidsource anchor before this node.
Optionalctx: ToJSContextA plain JavaScript representation of this node.
Optional__namedParameters: ToJSOptionsA plain JS representation of this node
-Optional_arg: unknownOptionalctx: ToJSContextOptionalctx: StringifyContextOptional_onComment: () => voidOptional_onChompKeep: () => voidOptional_arg: unknownOptionalctx: ToJSContextOptionalctx: StringifyContextOptional_onComment: () => voidOptional_onChompKeep: () => voidAttaches callbacks for the resolution and/or rejection of the Promise.
Optionalonfulfilled: (value: T) => TResult1 | PromiseLike<TResult1>The callback to execute when the Promise is resolved.
Optionalonrejected: (reason: any) => TResult2 | PromiseLike<TResult2>The callback to execute when the Promise is rejected.
A Promise for the completion of which ever callback is executed.
-A function that, when invoked, returns a promise that will be fulfilled with +
A function that, when invoked, returns a promise that will be fulfilled with a value of type T.
EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.
Returns a reference to the EventEmitter, so that calls can be chained.
Optionaldestination: WritableStreamOptionalencoding: BufferEncodingOptionalcb: (err?: Error) => voidOptionalencoding: BufferEncodingOptionalcb: (err?: Error) => voidOptionaldestination: WritableStreamOptionalencoding: BufferEncodingOptionalcb: (err?: Error) => voidOptionalencoding: BufferEncodingOptionalcb: (err?: Error) => voidOptionalerror: anyOptionalerror: anyThis Streams API interface represents a readable stream of byte data.
+This Streams API interface represents a readable stream of byte data.
Optionalreason: anyOptionaloptions: ReadableStreamGetReaderOptionsOptionaloptions: StreamPipeOptionsOptionaloptions: StreamPipeOptionsOptionaloptions: { preventCancel?: boolean }Optionalreason: anyOptionaloptions: ReadableStreamGetReaderOptionsOptionaloptions: StreamPipeOptionsOptionaloptions: StreamPipeOptionsOptionaloptions: { preventCancel?: boolean }EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.
Returns a reference to the EventEmitter, so that calls can be chained.
Optionaldestination: WritableStreamOptionalencoding: BufferEncodingOptionaldestination: WritableStreamOptionalencoding: BufferEncodingOptionalreturnOptionalvalue: anyOptionalthrowOptionale: anyOptionalreturnOptionalvalue: anyOptionalthrowOptionale: anyOptionalreason: anyOptionaloptions: { min?: number }Optionalreason: anyOptionalreason: anyOptionalmodeCreates a ReadableStreamBYOBReader and locks the stream to the new reader.
This call behaves the same way as the no-argument variant, except that it only works on readable byte streams, i.e. streams which were constructed specifically with the ability to handle "bring your own buffer" reading. The returned BYOB reader provides the ability to directly read individual chunks from the stream via its read() method, into developer-supplied buffers, allowing more precise control over allocation.
-Provides a convenient, chainable way of piping this readable stream through a transform stream (or any other { writable, readable } @@ -6,4 +6,4 @@ supplied pair, and returns the readable side for further use.
Piping a stream will lock it for the duration of the pipe, preventing any other consumer from acquiring a reader.
-OptionaldestroyOptionalmetadatametadata contains information of a handler. For example 'h2' refers this handler is for handling HTTP/2 requests, whereas 'h1' refers handling HTTP1 requests
-From T, pick a set of properties whose keys are in the union K
+From T, pick a set of properties whose keys are in the union K
OptionalhostOptionalhostnameOptionalinsecureOptionaljoinOptionallocalOptionallocalOptionallookupOptionalmaxOptionalmethodOptionalpathOptionalportOptionalprotocolOptionalsetOptionalsetOptionalsignalOptionalsocketOptionaltimeoutOptionaluniqueOptionalmethodOptionalpathOptionalportOptionalprotocolOptionalsetOptionalsetOptionalsignalOptionalsocketOptionaltimeoutOptionaluniqueFrom T, pick a set of properties whose keys are in the union K
+From T, pick a set of properties whose keys are in the union K
OptionalsignalOptionalsocketOptionalticket48-bytes of cryptographically strong pseudo-random data. See Session Resumption for more information.
-OptionaltimeoutOptionaluniqueOptionaltimeoutOptionaluniqueAn object that signs request objects with AWS credentials using one of the +
An object that signs request objects with AWS credentials using one of the AWS authentication protocols.
Sign the provided request for immediate dispatch.
-Optionaloptions: RequestSigningArgumentsOptionaloptions: RequestSigningArgumentsOptionaloptions: GetOptionsOptionaloptions: GetOptionsOptionaloptions: GetOptionsOptionaloptions: GetOptionsOptionaloptions: GetOptionsOptionaloptions: GetOptionsOptionaloptions: GetOptionsOptionaloptions: GetOptionsOptionaltotalThe total amount of time (in milliseconds) that was spent waiting between retry attempts.
-Interface that specifies the retry behavior
+Interface that specifies the retry behavior
OptionalmodeThe retry mode describing how the retry strategy control the traffic flow.
the retry behavior the will invoke the next handler and handle the retry accordingly. This function should also update the $metadata from the response accordingly.
InternalA configuration interface with methods called by runtime extension
+InternalA configuration interface with methods called by runtime extension
Get retry strategy used for all http requests
Set retry strategy used for all http requests
-Called before any retries (for the first call to the operation). It either @@ -14,4 +14,4 @@ either choose to allow another retry and send a new or updated token, or reject the retry attempt and report the error either in an exception or returning an error.
-A structure shape with the error trait. +
A structure shape with the error trait. https://smithy.io/2.0/spec/behavior-traits.html#smithy-api-retryable-trait
The configuration interface of S3Client class constructor that set the region, credentials and other options.
+The configuration interface of S3Client class constructor that set the region, credentials and other options.
OptionaluseOptionaluserThe application ID used to identify the application.
Optional Internalutf8The function that will be used to convert a UTF8-encoded string to a byte array.
Optional Internalutf8The function that will be used to convert binary data to a UTF-8 encoded string.
-pre-existing credentials.
unknown.
-InternalInternalGet retry strategy used for all http requests
Set retry strategy used for all http requests
-InternalInternalOptionalAccelerateOptionalBucketOptionalCopyOptionalDisableOptionalDisableOptionalDisableOptionalEndpointOptionalForceOptionalKeyOptionaloperationOptionalPrefixOptionalregionOptionalRegionOptionalUseOptionalUseOptionalUseOptionalUseOptionalUseOptionalUseOptionalAccelerateOptionalBucketOptionalCopyOptionalDisableOptionalDisableOptionalDisableOptionalEndpointOptionalForceOptionalKeyOptionaloperationOptionalPrefixOptionalregionOptionalRegionOptionalUseOptionalUseOptionalUseOptionalUseOptionalUseOptionalUseInternalInternalAll endpoint parameters with built-in bindings of AWS::S3::*
+All endpoint parameters with built-in bindings of AWS::S3::*
Optionals3Identity provider for an S3 feature.
OptionaluseWhether to use the S3 Transfer Acceleration endpoint by default
-Turns a value into an AST node.
If returning a non-Node value, the output will be wrapped as a Scalar.
Optional$refOptionaladditionalOptionalallOptionalanyOptionalconstOptionalcontentOptionalcontentOptionaldefaultOptionaldeprecatedOptionaldescriptionOptionaldiscriminatorOptionalenumOptionalexampleOptionalexamplesOptionalexclusiveOptionalexclusiveOptionalexternalOptionalformatOptionalitemsOptionalmaximumOptionalmaxOptionalmaxOptionalmaxOptionalminimumOptionalminOptionalminOptionalminOptionalmultipleOptionalnotOptionaloneOptionalpatternOptionalprefixOptionalpropertiesOptionalpropertyOptionalreadOptionalrequiredOptionaltitleOptionaltypeOptionaluniqueOptionalwriteOptionalxmlOptional$refOptionaladditionalOptionalallOptionalanyOptionalconstOptionalcontentOptionalcontentOptionaldefaultOptionaldeprecatedOptionaldescriptionOptionaldiscriminatorOptionalenumOptionalexampleOptionalexamplesOptionalexclusiveOptionalexclusiveOptionalexternalOptionalformatOptionalitemsOptionalmaximumOptionalmaxOptionalmaxOptionalmaxOptionalminimumOptionalminOptionalminOptionalminOptionalmultipleOptionalnotOptionaloneOptionalpatternOptionalprefixOptionalpropertiesOptionalpropertyOptionalreadOptionalrequiredOptionaltitleOptionaltypeOptionaluniqueOptionalwriteOptionalxmlThe interface contains mix-in utility functions to transfer the runtime-specific +
The interface contains mix-in utility functions to transfer the runtime-specific stream implementation to specified format. Each stream can ONLY be transformed once.
InternalInterface for internal function to inject stream utility functions +
InternalInterface for internal function to inject stream utility functions implementation
-Optionalticket48-bytes of cryptographically strong pseudo-random data. See Session Resumption for more information.
-Serde functions from the client config.
+Serde functions from the client config.
User input to a command. Reflects the userland representation of the union of data types the command can effectively handle.
@@ -7,4 +7,4 @@ type to e.g. HttpRequest with 'instanceof' operandDuring the build phase of the execution of a middleware stack, a built request may or may not be available.
-InternalTurns a serialization into a data object.
+InternalTurns a serialization into a data object.
InternalTurns a data object into a serialization.
+InternalTurns a data object into a serialization.
Optional InternalprotocolThese are automatically generated and will be passed to the config.protocol if given as a constructor.
-Type that is implemented by all Smithy shapes marked with the +
Type that is implemented by all Smithy shapes marked with the error trait.
Optional Readonly$retryableIndicates that an error MAY be retried by the client.
Optional Readonly$serviceThe service that encountered the exception.
ReadonlynameThe shape ID name of the exception.
-OptionalsignalCan be used to cancel awaiting events.
-OptionalallowOptionalautoOptionalconstructOptionaldecodeOptionaldefaultOptionaldestroyOptionalemitOptionalencodingOptionalfinalOptionalhighOptionalobjectOptionalreadOptionalreadableOptionalreadableOptionalsignalWhen provided the corresponding AbortController can be used to cancel an asynchronous action.
OptionalwritableOptionalwritableOptionalwritableOptionalwriteOptionalwritevOptionalwritableOptionalwritableOptionalwritableOptionalwriteOptionalwritevOptionalwritableOptionalautoOptionalconstructOptionaldestroyOptionalemitOptionalencodingOptionalhighOptionalobjectOptionalreadOptionalsignalWhen provided the corresponding AbortController can be used to cancel an asynchronous action.
OptionalautoOptionalconstructOptionaldestroyOptionalemitOptionalhighOptionalobjectOptionalsignalWhen provided the corresponding AbortController can be used to cancel an asynchronous action.
OptionalallowOptionalautoOptionalconstructOptionaldecodeOptionaldefaultOptionaldestroyOptionalemitOptionalencodingOptionalfinalOptionalflushOptionalhighOptionalobjectOptionalreadOptionalreadableOptionalreadableOptionalsignalWhen provided the corresponding AbortController can be used to cancel an asynchronous action.
OptionaltransformOptionalwritableOptionalwritableOptionalwritableOptionalwriteOptionalwritevOptionaltransformOptionalwritableOptionalwritableOptionalwritableOptionalwriteOptionalwritevOptionalautoOptionalconstructOptionaldecodeOptionaldefaultOptionaldestroyOptionalemitOptionalfinalOptionalhighOptionalobjectOptionalsignalWhen provided the corresponding AbortController can be used to cancel an asynchronous action.
OptionalwriteOptionalwritevOptionalwriteOptionalwritevOptionalerrorOptionalreadableOptionalsignalWhen provided the corresponding AbortController can be used to cancel an asynchronous action.
OptionalwritableOptionalwritableA function that converts a stream into an array of bytes.
+A function that converts a stream into an array of bytes.
The low-level native stream from browser or Nodejs runtime
-A function that calculates the hash of a data stream. Determining the hash +
A function that calculates the hash of a data stream. Determining the hash will consume the stream, so only replayable streams should be provided to an implementation of this interface.
-OptionalsignalOptionalsignalInternalSchema for the structure aggregate type.
+InternalSchema for the structure aggregate type.
OptionalautoOptionalautoOptionalblockOptionalfamilyOptionalhintsOptionalhostOptionalkeepOptionalkeepOptionallocalOptionallocalOptionallookupOptionalnoOptionalblockOptionalfamilyOptionalhintsOptionalhostOptionalkeepOptionalkeepOptionallocalOptionallocalOptionallookupOptionalnoOptionalonInternalA schema that has traits.
+InternalA schema that has traits.
Browser-compatible URL class, implemented by following the WHATWG URL
+
Browser-compatible URL class, implemented by following the WHATWG URL
Standard. Examples of parsed URLs may be found in the Standard itself.
The URL class is also available on the global object.
In accordance with browser conventions, all properties of URL objects
@@ -128,4 +128,4 @@
OptionalreturnOptionalvalue: anyOptionalthrowOptionale: anyOptionalreturnOptionalvalue: anyOptionalthrowOptionale: anyOptionalreason: anyOptionalreason: anyOptionalreason: anyOptionalreason: anyThis Streams API interface provides a standard abstraction for writing +
This Streams API interface provides a standard abstraction for writing streaming data to a destination, known as a sink. This object comes with built-in back pressure and queuing.
Optionalreason: anyOptionalreason: anyEventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.
Returns a reference to the EventEmitter, so that calls can be chained.
Optionalcb: (err?: Error) => voidOptionalencoding: BufferEncodingOptionalcb: (err?: Error) => voidOptionalcb: (err?: Error) => voidOptionalencoding: BufferEncodingOptionalcb: (err?: Error) => voidThis Streams API interface represents a controller allowing control of a +
This Streams API interface represents a controller allowing control of a WritableStream's state. When constructing a WritableStream, the underlying sink is given a corresponding WritableStreamDefaultController instance to manipulate.
This Streams API interface is the object returned by +
This Streams API interface is the object returned by WritableStream.getWriter() and once created locks the < writer to the WritableStream ensuring that no other streams can write to the underlying sink.
@@ -9,4 +9,4 @@ close releaseA client protocol defines how to convert a message (e.g. HTTP request/response) to and from a data object.
+A client protocol defines how to convert a message (e.g. HTTP request/response) to and from a data object.
the payload codec if the requests/responses have a symmetric format. It otherwise may return null.
the Smithy qualified shape id.
-A codec creates serializers and deserializers for some format such as JSON, XML, or CBOR.
+A codec creates serializers and deserializers for some format such as JSON, XML, or CBOR.
Schema for an operation.
+Schema for an operation.
InternalInternalTurns a serialization into a data object.
+Turns a serialization into a data object.
Turns a data object into a serialization.
+Turns a data object into a serialization.
A collection of JSON patch operations, defined by the Operation class.
A collection of JSON patch operations, defined by the Operation class.
Lambda handler returned by ApiLambdaApp.createHandler().
Lambda handler returned by ApiLambdaApp.createHandler().
Request shape accepted by ApiLambdaApp.
Request shape accepted by ApiLambdaApp.
Native AWS Lambda HTTP event shapes supported by lambda-api.
Native AWS Lambda HTTP event shapes supported by lambda-api.
Works with Lambda Proxy Integration for Rest API or HTTP API integration Payload Format version 1.0
+Works with Lambda Proxy Integration for Rest API or HTTP API integration Payload Format version 1.0
Default Proxy event with no Authorizer
-Default Proxy event with no Authorizer
+The blob Smithy type, in JS as Uint8Array and other representations +
The blob Smithy type, in JS as Uint8Array and other representations such as Buffer, string, or Readable(Stream) depending on circumstances.
-Sentinel values for Blob schema.
-Sentinel values for Blob schema.
+Defines the TReturn type used for built-in iterators produced by Array, Map, Set, and others.
+
Defines the TReturn type used for built-in iterators produced by Array, Map, Set, and others.
This is undefined when strictBuiltInIteratorReturn is true; otherwise, this is any.
NodeJS-style callback parameter for the Handler type. +
NodeJS-style callback parameter for the Handler type. Can be used instead of returning a promise, see the AWS documentation for the handler programming model.
@@ -12,4 +12,4 @@trace is an empty array.
Optionalresult: TResultParameter to use to provide the result payload for a successful lambda execution.
Pass null or undefined for the error parameter to use this parameter.
A Date object, a unix (epoch) timestamp in seconds, or a string that can be
+
A Date object, a unix (epoch) timestamp in seconds, or a string that can be
understood by the JavaScript Date constructor.
Option determining how certain default configuration options are resolved in the SDK. It can be one of the value listed below:
+Option determining how certain default configuration options are resolved in the SDK. It can be one of the value listed below:
"standard": The STANDARD mode provides the latest recommended default values that should be safe to run in most scenarios
Note that the default values vended from this mode might change as best practices may evolve. As a result, it is encouraged to perform tests when upgrading the SDK
"in-region": The IN_REGION mode builds on the standard mode and includes optimization tailored for applications which call AWS services from within the same AWS region
Note that the default values vended from this mode might change as best practices may evolve. As a result, it is encouraged to perform tests when upgrading the SDK
Optionalerror: ErrorOptionalerror: ErrorThe interface that AWS Lambda will invoke your handler with. +
The interface that AWS Lambda will invoke your handler with. There are more specialized types for many cases where AWS services invoke your lambda, but you can directly use this type for when you are invoking your lambda directly.
@@ -32,4 +32,4 @@import { Handler } from 'aws-lambda'
import https from 'https'
let url = "https://docs.aws.amazon.com/lambda/latest/dg/welcome.html"
export const handler: Handler<void, number> = (event, context, callback) => {
https.get(url, (res) => {
callback(null, res.statusCode)
}).on('error', (e) => {
callback(Error(e))
})
}
Optionalnext: NextFunctionOptionalnext: NextFunctionA mapping of header names to string values. Multiple values for the same +
A mapping of header names to string values. Multiple values for the same
header should be represented as a single string with values separated by
, .
Keys should be considered case insensitive, even if this is not enforced by a @@ -10,4 +10,4 @@
The SDK may at any point during processing remove one of the object properties in favor of the other. The headers may or may not be combined, and the SDK will not deterministically select which header candidate to use.
-InternalInternalA type representing the accepted user inputs for the requestHandler field
+
A type representing the accepted user inputs for the requestHandler field
of a client's constructor object.
You may provide an instance of an HttpHandler, or alternatively provide the constructor arguments as an object which will be passed @@ -9,4 +9,4 @@ configured to use other default implementations such as Websocket or HTTP2.
The fallback type Record<string, unknown> is part of the union to allow passing constructor params to an unknown requestHandler type.
-Optionaloptions: IsBoundOptionsOptionaloptions: IsBoundOptionsOptionalmessage: anyOptionaladditionalInfo: LoggerFunctionAdditionalInfoOptionalmessage: anyOptionaladditionalInfo: LoggerFunctionAdditionalInfoConvert string literal type to lowercase
-Convert string literal type to lowercase
+InternalIndicates the schema is a member of a parent Structure schema. +
InternalIndicates the schema is a member of a parent Structure schema. It may also have a set of member traits distinct from its target shape's traits.
Utility type mapper
-Utility type mapper
+Includes all numeric Smithy types except bigInteger and bigDecimal. +
Includes all numeric Smithy types except bigInteger and bigDecimal. byte, short, integer, long, float, double, intEnum.
-ParsedNode values, and
is expected to return a boolean indicating their equality.
Default: true
A mapping of query parameter names to strings or arrays of strings, with the +
A mapping of query parameter names to strings or arrays of strings, with the second being used when a parameter contains a list of values. Value can be set to null when query is not in key-value pairs shape
-[start, value-end, node-end]
[start, value-end, node-end]
This is a connection level error such as a socket timeout, socket connect +
This is a connection level error such as a socket timeout, socket connect error, tls negotiation timeout etc... Typically these should never be applied for non-idempotent request types since in this scenario, it's impossible to know whether the operation had @@ -9,4 +9,4 @@ by the client to be something that should be retried.
Doesn't count against any budgets. This could be something like a 401 challenge in Http.
-Obtain the return type of a function type
-Obtain the return type of a function type
+InternalA schema is an object or value that describes how to serialize/deserialize data.
+InternalA schema is an object or value that describes how to serialize/deserialize data.
Default: false
OptionaltoOverride default values for toString() options.
InternalA schema "reference" is either a schema or a function that +
Traits attached to schema objects.
+Traits attached to schema objects.
When this is a number, it refers to a pre-allocated trait combination that is equivalent to one of the object type's variations.
-See https://smithy.io/2.0/trait-index.html for individual definitions.
+See https://smithy.io/2.0/trait-index.html for individual definitions.
See https://aws.amazon.com/blogs/developer/service-error-handling-modular-aws-sdk-js/
+See https://aws.amazon.com/blogs/developer/service-error-handling-modular-aws-sdk-js/
This type should not be used in your application. Users of the AWS SDK for JavaScript v3 service clients should prefer to use the specific Exception classes corresponding to each operation. @@ -7,4 +7,4 @@
If no exceptions are enumerated by a particular Command operation, the base exception for the service should be used. Each client exports a base ServiceException prefixed with the service name.
-Simple schemas are those corresponding to simple Smithy types.
+Simple schemas are those corresponding to simple Smithy types.
Optionalerror: Error | nullOptionaldata: anyOptionalerror: Error | nullOptionaldata: anyIncludes string and enum Smithy types.
-Includes string and enum Smithy types.
+OptionalactualOptionalallOptionalforceOptionalimplicitOptionalindentOptionalinOptionalresolvedOptionalactualOptionalallOptionalforceOptionalimplicitOptionalindentOptionalinOptionalresolvedSmithy type timestamp, in JS as native Date object.
-Smithy type timestamp, in JS as native Date object.
+Sentinel value for Timestamp schema. +
Sentinel value for Timestamp schema. "Default" means unspecified and to use the protocol serializer's default format.
-Default: 'true'
A bitvector representing a traits object.
+A bitvector representing a traits object.
Vector index to trait: 0 - httpLabel 1 - idempotent @@ -9,4 +9,4 @@ 6 - httpQueryParams
The singular trait values are enumerated for quick identification, but
combination values are left to the number union type.
InternalRepresents the components parts of a Uniform Resource Identifier used to +
InternalRepresents the components parts of a Uniform Resource Identifier used to construct the target location of a Request.
Signal value for the Smithy void value. Typically used for +
Signal value for the Smithy void value. Typically used for operation input and outputs.
-User agent data that to be put into the request's user +
User agent data that to be put into the request's user agent.
-A tuple that represents an API name and optional version +
A tuple that represents an API name and optional version of a library built using the AWS SDK.
-Indicates the schema is a member of a parent Structure schema. +
Indicates the schema is a member of a parent Structure schema. It may also have a set of member traits distinct from its target shape's traits.
-A schema is an object or value that describes how to serialize/deserialize data.
-A schema is an object or value that describes how to serialize/deserialize data.
+A schema "reference" is either a schema or a function that +
Optionalreason: anyOptionalreason: anyProvides functionality common to all JavaScript objects.
-Provides functionality common to all JavaScript objects.
+Optionalstrategy: QueuingStrategy<Uint8Array<ArrayBufferLike>>OptionalunderlyingSource: UnderlyingSource<R>Optionalstrategy: QueuingStrategy<R>Optionalstrategy: QueuingStrategy<Uint8Array<ArrayBufferLike>>OptionalunderlyingSource: UnderlyingSource<R>Optionalstrategy: QueuingStrategy<R>ConstDetermines when a checksum will be calculated for request payloads.
+ConstDetermines when a checksum will be calculated for request payloads.
ReadonlyWHEN_REQUIRED: "WHEN_REQUIRED"When set, a checksum will only be calculated for request payloads of operations
modeled with the httpChecksum trait where requestChecksumRequired is true
OR where a requestAlgorithmMember is modeled and the user sets it.
@@ -7,4 +7,4 @@
modeled with the httpChecksum trait where requestChecksumRequired is true
AND/OR a requestAlgorithmMember is modeled.
httpChecksum
ConstDetermines when checksum validation will be performed on response payloads.
+ConstDetermines when checksum validation will be performed on response payloads.
ReadonlyWHEN_REQUIRED: "WHEN_REQUIRED"When set, checksum validation MUST NOT be performed on response payloads of operations UNLESS
the SDK supports the modeled checksum algorithms AND the user has set the requestValidationModeMember to ENABLED.
It is currently impossible to model an operation as requiring a response checksum,
@@ -7,4 +7,4 @@
modeled with the httpChecksum trait where responseAlgorithms is modeled,
except when no modeled checksum algorithms are supported by an SDK.
httpChecksum
OptionalunderlyingSink: UnderlyingSink<W>Optionalstrategy: QueuingStrategy<W>OptionalunderlyingSink: UnderlyingSink<W>Optionalstrategy: QueuingStrategy<W>ConstConst
Application base class which combines the
Server,Container(seeInversifyJS) +Class ApiApp
AbstractApplication base class which combines the
@@ -6,7 +6,7 @@ compatible with either API Gateway or an ALB.Server,Container(seeInversifyJS) andAppConfigclasses to create a decorator driven API with typescript middleware and dependency injection. It uses thelambda-apipackage as the underlying HTTP API framework.Extending this class will allow creating an app implementation for runtimes, AWS Lambda, Local Web Server etc.
-Hierarchy (View Summary)
Index
Constructors
Hierarchy (View Summary)
Index
Constructors
Properties
Containerusingautobindflag set totrueifautoInjectionEnabledistrue. If you pass your own instanceautoInjectionEnabledmust reflect the autobind flag passed to the Container. -Returns ApiApp
Properties
ProtectedReadonlyapiProtectedapp(Optional) Application config to pass to
-lambda-api, defaults to newAppConfig.Protectedapp(Optional)
InversifyJSIOCContainerinstance which can +Returns ApiApp
Properties
ProtectedReadonlyapiProtectedapp(Optional) Application config to pass to
+lambda-api, defaults to newAppConfig.Protectedapp(Optional)
-InversifyJSIOCContainerinstance which can build controllers and error interceptors, defaults to newContainerusingautobindflag set totrueifautoInjectionEnabledistrue. If you pass your own instanceautoInjectionEnabledmust reflect the autobind flag passed to the Container.Protectedauto(Optional) Is auto injection enabled in the IOC container? Defaults to
-true.ProtectedOptionalReadonlycontrollers(Optional) Paths to the directories that contain controller
jsfiles that +Protectedauto(Optional) Is auto injection enabled in the IOC container? Defaults to
+true.ProtectedOptionalReadonlycontrollers(Optional) Paths to the directories that contain controller
-jsfiles that declare controllers. Required if the defaultContaineris used, or theautoInjectionEnabledis set totrue. Ignored if theautoInjectionEnabledis set tofalse.ProtectedinitialisedProtectedReadonlylogProtectedloggerAccessors
middleware
Returns MiddlewareRegistry
Methods
configure
Configure the
+APIinstance from thelambda-apipackage.ProtectedinitialisedProtectedReadonlylogProtectedloggerAccessors
middleware
Returns MiddlewareRegistry
Methods
configure
Configure the
APIinstance from thelambda-apipackage.Parameters
Function that takes an
-APIinstance as a parameter.Returns void
configure
Configure the
+InversifyJSIOCContainerinstance.Returns void
configure
Configure the
InversifyJSIOCContainerinstance.Parameters
Function that takes a
-Containerinstance as a parameter.Returns void
initialise
Initialise all controllers and endpoints declared using decorators.
-Returns Promise<void>
AbstractrunRun using the passed event and context, ultimately should call the +
Returns void